Skip to content

Onconova API 1.0.0

Welcome to the Onconova API — a secure, standards-based interface designed to facilitate the exchange, management, and analysis of research data related to cancer genomics, clinical records, and associated metadata. This API provides an extensive set of RESTful endpoints enabling authorized users to perform full CRUD (Create, Read, Update, Delete) operations on various resources within the platform’s data ecosystem.

The primary objective of this API is to support precision oncology research by enabling interoperability between data systems, promoting data sharing among research institutions, and streamlining workflows for clinical and genomic data management in a secure, authenticated environment.

Authentication

To ensure the security and integrity of cancer research data, all API requests require proper authentication.

A valid session token must be obtained prior to accessing any protected endpoint. This token must be included in the request header X-Session-Token.

The authentication and authorization flows for obtaining and managing session tokens are provided through the AllAuth authentication service. This includes endpoints for user login, logout, password management, and token renewal. For complete details on implementing authentication and managing session tokens, please refer to the AllAuth API documentation.

Important: Unauthorized requests or those missing valid authentication tokens will receive an HTTP 401 Unauthorized response.

Terminologies

Many resources take objects of the type CodedConcept to represent concepts from coded terminologies. Each property of the type CodedConcept in a schema will have an associated x-terminology attribute. The full list of CodedConcept objects allowed for specific resource properties can be retrieved through the terminology endpoint by passing the x-terminology value as the terminologyName parameter.

Terms and Conditions

By accessing and using this website, you agree to comply with and be bound by the following terms and conditions. The content provided on this API is intended solely for general informational and research purposes. While we strive to ensure the information is accurate and reliable, we do not make any express or implied warranties about the accuracy, adequacy, validity, reliability, availability, or completeness of the content.

The information presented on this platform is provided in good faith. However, we do not accept any liability for any loss or damage incurred as a result of using the site or relying on the information provided. Your use of this site and any reliance on the content is solely at your own risk.

These terms and conditions may be updated from time to time, and it is your responsibility to review them regularly to ensure compliance.

License

The Onconova API specification is made available under the MIT License, a permissive open-source license that allows users to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the inclusion of the original copyright and license.


License: MIT

Servers

Description URL
API server https://{domain}:{port}/api

API Health


GET /api/v1/healthcheck

Health Check

Description

Performs a health check of the server, database connection, and database migrations.

Response 200 OK

{
    "server": "string",
    "database": null,
    "database_connection_time_ms": null,
    "migrations": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing the health status of the server and its components.\n\nAttributes:\n    server (Literal[\"ok\"]): Indicates whether the server is online.\n    database (Union[Literal[\"ok\"], Literal[\"error\"]]): Indicates the status of the database connection.\n    database_connection_time_ms (Optional[float]): Time taken to connect to the database in milliseconds.\n    migrations (Union[Literal[\"ok\"], Literal[\"pending\"], Literal[\"error\"]]): Status of database migrations.",
    "properties": {
        "server": {
            "const": "ok",
            "description": "Whether the server is online",
            "title": "Server Status",
            "type": "string"
        },
        "database": {
            "anyOf": [
                {
                    "const": "ok",
                    "type": "string"
                },
                {
                    "const": "error",
                    "type": "string"
                }
            ],
            "description": "Whether the database is online",
            "title": "Database Status"
        },
        "database_connection_time_ms": {
            "anyOf": [
                {
                    "type": "number"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Database connection time in milliseconds",
            "title": "Database Connection Time"
        },
        "migrations": {
            "anyOf": [
                {
                    "const": "ok",
                    "type": "string"
                },
                {
                    "const": "pending",
                    "type": "string"
                },
                {
                    "const": "error",
                    "type": "string"
                }
            ],
            "description": "Whether there are pending migrations",
            "title": "Migration Status"
        }
    },
    "required": [
        "server",
        "database",
        "migrations"
    ],
    "title": "HealthCheck",
    "type": "object"
}

Response 401 Unauthorized

Response 400 Bad Request

Response 403 Forbidden

Response 500 Internal Server Error

Authentication


POST /api/v1/auth/session

Login

Description

Authenticates a user using the provided credentials.

Request body

{
    "username": "string",
    "password": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Schema representing user credentials required for authentication.\n\nAttributes:\n    username (str): The username of the user.\n    password (str): The password associated with the username.",
    "properties": {
        "username": {
            "description": "The username of the user.",
            "title": "Username",
            "type": "string"
        },
        "password": {
            "description": "The password associated with the username.",
            "title": "Password",
            "type": "string"
        }
    },
    "required": [
        "username",
        "password"
    ],
    "title": "UserCredentials",
    "type": "object"
}

Response 200 OK

{
    "sessionToken": "string",
    "accessToken": "string",
    "isAuthenticated": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing authentication metadata.\n\nAttributes:\n    sessionToken (Optional[str]): The session token associated with the authentication, if available.\n    accessToken (Optional[str]): The access token for the authenticated session, if available.\n    isAuthenticated (bool): Indicates whether the user is authenticated.",
    "properties": {
        "sessionToken": {
            "description": "The session token associated with the authentication, if available.",
            "title": "Session Token",
            "type": "string"
        },
        "accessToken": {
            "description": "The access token for the authenticated session, if available.",
            "title": "Access Token",
            "type": "string"
        },
        "isAuthenticated": {
            "description": "Indicates whether the user is authenticated.",
            "title": "Is Authenticated",
            "type": "boolean"
        }
    },
    "required": [
        "isAuthenticated"
    ],
    "title": "AuthenticationMeta",
    "type": "object"
}

Response 401 Unauthorized

Response 400 Bad Request

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/auth/provider/session

Login With Provider Token

Description

Authenticates a user using a provider token.

Request body

{
    "provider": "string",
    "process": null,
    "token": {
        "client_id": "string",
        "id_token": "string",
        "access_token": "string"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Schema representing a user's provider token information.\n\nAttributes:\n    provider (str): The name of the authentication provider (e.g., 'google', 'facebook').\n    process (Literal[\"login\"] | Literal[\"connect\"]): The process type, either 'login' or 'connect'.\n    token (UserProviderClientToken): The token object containing provider-specific authentication details.",
    "properties": {
        "provider": {
            "description": "The name of the authentication provider (e.g., 'google', 'facebook').",
            "title": "Provider",
            "type": "string"
        },
        "process": {
            "anyOf": [
                {
                    "const": "login",
                    "type": "string"
                },
                {
                    "const": "connect",
                    "type": "string"
                }
            ],
            "description": "The process type, either 'login' or 'connect'.",
            "title": "Process Type"
        },
        "token": {
            "$ref": "#/components/schemas/UserProviderClientToken",
            "description": "The token object containing provider-specific authentication details.",
            "title": "Provider Token"
        }
    },
    "required": [
        "provider",
        "process",
        "token"
    ],
    "title": "UserProviderToken",
    "type": "object"
}

Response 200 OK

{
    "sessionToken": "string",
    "accessToken": "string",
    "isAuthenticated": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing authentication metadata.\n\nAttributes:\n    sessionToken (Optional[str]): The session token associated with the authentication, if available.\n    accessToken (Optional[str]): The access token for the authenticated session, if available.\n    isAuthenticated (bool): Indicates whether the user is authenticated.",
    "properties": {
        "sessionToken": {
            "description": "The session token associated with the authentication, if available.",
            "title": "Session Token",
            "type": "string"
        },
        "accessToken": {
            "description": "The access token for the authenticated session, if available.",
            "title": "Access Token",
            "type": "string"
        },
        "isAuthenticated": {
            "description": "Indicates whether the user is authenticated.",
            "title": "Is Authenticated",
            "type": "boolean"
        }
    },
    "required": [
        "isAuthenticated"
    ],
    "title": "AuthenticationMeta",
    "type": "object"
}

Response 400 Bad Request

Response 401 Unauthorized

Response 500 Internal Server Error

Users


GET /api/v1/users

Get All Users Matching The Query

Description

Retrieves all user objects that match the specified query filters.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
accessLevel.between query array No Access level - Filter for entries with values between two specified values (inclusive)
accessLevel.equal query integer No Access level - Filter for entries with values exactly equal to the specified value
accessLevel.greaterThan query integer No Access level - Filter for entries with values greater than the specified value
accessLevel.greaterThanOrEqual query integer No Access level - Filter for entries with values greater than or equal to the specified value
accessLevel.lessThan query integer No Access level - Filter for entries with values less than the specified value
accessLevel.lessThanOrEqual query integer No Access level - Filter for entries with values less than or equal to the specified value
accessLevel.not.between query array No Access level - Filter for entries with values between two specified values (inclusive)
accessLevel.not.equal query integer No Access level - Filter for entries with values not equal to the specified value
canExportData query boolean No Export Data - Filter for yes/no statement
canManageCases query boolean No Manage Cases - Filter for yes/no statement
canManageProjects query boolean No Manage Projects - Filter for yes/no statement
canManageUsers query boolean No Manage Users - Filter for yes/no statement
canViewCases query boolean No View Cases - Filter for yes/no statement
canViewCohorts query boolean No View Cohorts - Filter for yes/no statement
canViewDatasets query boolean No View Datasets - Filter for yes/no statement
canViewProjects query boolean No View Projects - Filter for yes/no statement
canViewUsers query boolean No View Users - Filter for yes/no statement
department query string No Department - Filter for full text matches
department.anyOf query array No Department - Filter for entries where at least one reference matches the query
department.beginsWith query string No Department - Filter for entries starting with the text
department.contains query string No Department - Filter for partial text matches
department.endsWith query string No Department - Filter for entries ending with the text
department.exists query boolean No Department - Filter for entries with a value
department.not query string No Department - Filter for full text mismatches
department.not.anyOf query array No Department - Filter for entries where at least one reference mismatches the query
department.not.beginsWith query string No Department - Filter for entries not starting with the text
department.not.contains query string No Department - Filter for partial text mismatches
department.not.endsWith query string No Department - Filter for entries not ending with the text
department.not.exists query boolean No Department - Filter for entries without a value
email query string No Email Address - Filter for full text matches
email.anyOf query array No Email Address - Filter for entries where at least one reference matches the query
email.beginsWith query string No Email Address - Filter for entries starting with the text
email.contains query string No Email Address - Filter for partial text matches
email.endsWith query string No Email Address - Filter for entries ending with the text
email.exists query boolean No Email Address - Filter for entries with a value
email.not query string No Email Address - Filter for full text mismatches
email.not.anyOf query array No Email Address - Filter for entries where at least one reference mismatches the query
email.not.beginsWith query string No Email Address - Filter for entries not starting with the text
email.not.contains query string No Email Address - Filter for partial text mismatches
email.not.endsWith query string No Email Address - Filter for entries not ending with the text
email.not.exists query boolean No Email Address - Filter for entries without a value
externalSource query string No External source - Filter for full text matches
externalSource.anyOf query array No External source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External source - Filter for entries starting with the text
externalSource.contains query string No External source - Filter for partial text matches
externalSource.endsWith query string No External source - Filter for entries ending with the text
externalSource.exists query boolean No External source - Filter for entries with a value
externalSource.not query string No External source - Filter for full text mismatches
externalSource.not.anyOf query array No External source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External source - Filter for entries not starting with the text
externalSource.not.contains query string No External source - Filter for partial text mismatches
externalSource.not.endsWith query string No External source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External source - Filter for entries without a value
firstName query string No First Name - Filter for full text matches
firstName.anyOf query array No First Name - Filter for entries where at least one reference matches the query
firstName.beginsWith query string No First Name - Filter for entries starting with the text
firstName.contains query string No First Name - Filter for partial text matches
firstName.endsWith query string No First Name - Filter for entries ending with the text
firstName.exists query boolean No First Name - Filter for entries with a value
firstName.not query string No First Name - Filter for full text mismatches
firstName.not.anyOf query array No First Name - Filter for entries where at least one reference mismatches the query
firstName.not.beginsWith query string No First Name - Filter for entries not starting with the text
firstName.not.contains query string No First Name - Filter for partial text mismatches
firstName.not.endsWith query string No First Name - Filter for entries not ending with the text
firstName.not.exists query boolean No First Name - Filter for entries without a value
fullName query string No Full Name - Filter for full text matches
fullName.anyOf query array No Full Name - Filter for entries where at least one reference matches the query
fullName.beginsWith query string No Full Name - Filter for entries starting with the text
fullName.contains query string No Full Name - Filter for partial text matches
fullName.endsWith query string No Full Name - Filter for entries ending with the text
fullName.not query string No Full Name - Filter for full text mismatches
fullName.not.anyOf query array No Full Name - Filter for entries where at least one reference mismatches the query
fullName.not.beginsWith query string No Full Name - Filter for entries not starting with the text
fullName.not.contains query string No Full Name - Filter for partial text mismatches
fullName.not.endsWith query string No Full Name - Filter for entries not ending with the text
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
isActive query boolean No Active - Filter for yes/no statement
isProvided query boolean No Is Provided - Filter for yes/no statement
isServiceAccount query boolean No Is service account? - Filter for yes/no statement
isSystemAdmin query boolean No System Administrator - Filter for yes/no statement
lastLogin.after query string No Last Login - Filter for entries with dates after the specified value
lastLogin.before query string No Last Login - Filter for entries with dates before the specified value
lastLogin.between query array No Last Login - Filter for entries with dates between two specified values (inclusive)
lastLogin.exists query boolean No Last Login - Filter for entries with a value
lastLogin.not.between query array No Last Login - Filter for entries with dates not between two specified values (inclusive)
lastLogin.not.exists query boolean No Last Login - Filter for entries without a value
lastLogin.not.on query string No Last Login - Filter for entries with dates not matching the specified value
lastLogin.on query string No Last Login - Filter for entries with dates exactly matching the specified value
lastLogin.onOrAfter query string No Last Login - Filter for entries with dates on or after the specified value
lastLogin.onOrBefore query string No Last Login - Filter for entries with dates on or before the specified value
lastName query string No Last Name - Filter for full text matches
lastName.anyOf query array No Last Name - Filter for entries where at least one reference matches the query
lastName.beginsWith query string No Last Name - Filter for entries starting with the text
lastName.contains query string No Last Name - Filter for partial text matches
lastName.endsWith query string No Last Name - Filter for entries ending with the text
lastName.exists query boolean No Last Name - Filter for entries with a value
lastName.not query string No Last Name - Filter for full text mismatches
lastName.not.anyOf query array No Last Name - Filter for entries where at least one reference mismatches the query
lastName.not.beginsWith query string No Last Name - Filter for entries not starting with the text
lastName.not.contains query string No Last Name - Filter for partial text mismatches
lastName.not.endsWith query string No Last Name - Filter for entries not ending with the text
lastName.not.exists query boolean No Last Name - Filter for entries without a value
limit query integer 10 No
offset query integer 0 No
ordering query None No
organization query string No Organization - Filter for full text matches
organization.anyOf query array No Organization - Filter for entries where at least one reference matches the query
organization.beginsWith query string No Organization - Filter for entries starting with the text
organization.contains query string No Organization - Filter for partial text matches
organization.endsWith query string No Organization - Filter for entries ending with the text
organization.exists query boolean No Organization - Filter for entries with a value
organization.not query string No Organization - Filter for full text mismatches
organization.not.anyOf query array No Organization - Filter for entries where at least one reference mismatches the query
organization.not.beginsWith query string No Organization - Filter for entries not starting with the text
organization.not.contains query string No Organization - Filter for partial text mismatches
organization.not.endsWith query string No Organization - Filter for entries not ending with the text
organization.not.exists query boolean No Organization - Filter for entries without a value
provider query string No Provider - Filter for full text matches
provider.anyOf query array No Provider - Filter for entries where at least one reference matches the query
provider.beginsWith query string No Provider - Filter for entries starting with the text
provider.contains query string No Provider - Filter for partial text matches
provider.endsWith query string No Provider - Filter for entries ending with the text
provider.exists query boolean No Provider - Filter for entries with a value
provider.not query string No Provider - Filter for full text mismatches
provider.not.anyOf query array No Provider - Filter for entries where at least one reference mismatches the query
provider.not.beginsWith query string No Provider - Filter for entries not starting with the text
provider.not.contains query string No Provider - Filter for partial text mismatches
provider.not.endsWith query string No Provider - Filter for entries not ending with the text
provider.not.exists query boolean No Provider - Filter for entries without a value
role query None No Role - Filter for single value choice
role.anyOf query array No Role - ('Filter for excluding a subset of value choices',)
role.not query None No Role - ('Filter for all but a single value choice',)
shareable query boolean No Shareable - Filter for yes/no statement
shareable.exists query boolean No Shareable - Filter for entries with a value
shareable.not.exists query boolean No Shareable - Filter for entries without a value
title query string No Title - Filter for full text matches
title.anyOf query array No Title - Filter for entries where at least one reference matches the query
title.beginsWith query string No Title - Filter for entries starting with the text
title.contains query string No Title - Filter for partial text matches
title.endsWith query string No Title - Filter for entries ending with the text
title.exists query boolean No Title - Filter for entries with a value
title.not query string No Title - Filter for full text mismatches
title.not.anyOf query array No Title - Filter for entries where at least one reference mismatches the query
title.not.beginsWith query string No Title - Filter for entries not starting with the text
title.not.contains query string No Title - Filter for partial text mismatches
title.not.endsWith query string No Title - Filter for entries not ending with the text
title.not.exists query boolean No Title - Filter for entries without a value
username query string No Username - Filter for full text matches
username.anyOf query array No Username - Filter for entries where at least one reference matches the query
username.beginsWith query string No Username - Filter for entries starting with the text
username.contains query string No Username - Filter for partial text matches
username.endsWith query string No Username - Filter for entries ending with the text
username.not query string No Username - Filter for full text mismatches
username.not.anyOf query array No Username - Filter for entries where at least one reference mismatches the query
username.not.beginsWith query string No Username - Filter for entries not starting with the text
username.not.contains query string No Username - Filter for partial text mismatches
username.not.endsWith query string No Username - Filter for entries not ending with the text

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "lastLogin": "2022-04-13T15:42:05.901Z",
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "isActive": true,
            "externalSource": "string",
            "externalSourceId": "string",
            "isServiceAccount": true,
            "title": "string",
            "organization": "string",
            "department": "string",
            "accessLevel": 0,
            "shareable": true,
            "id": "e13328ab-669c-4e98-a804-4701597dfa3d",
            "fullName": "string",
            "role": "External",
            "canViewCases": true,
            "canViewProjects": true,
            "canViewCohorts": true,
            "canViewUsers": true,
            "canViewDatasets": true,
            "canManageCases": true,
            "canExportData": true,
            "canManageProjects": true,
            "canManageUsers": true,
            "isSystemAdmin": true,
            "isProvided": true,
            "provider": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/User"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[User]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/users

Create User

Description

Creates a new user with the provided payload.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "lastLogin": "2022-04-13T15:42:05.901Z",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "isActive": true,
    "externalSource": "string",
    "externalSourceId": "string",
    "isServiceAccount": true,
    "title": "string",
    "organization": "string",
    "department": "string",
    "accessLevel": 0,
    "shareable": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "lastLogin": {
            "description": "",
            "format": "date-time",
            "title": "Last Login",
            "type": "string"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "title": "Username",
            "type": "string"
        },
        "firstName": {
            "description": "",
            "maxLength": 150,
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "",
            "maxLength": 150,
            "title": "Last Name",
            "type": "string"
        },
        "email": {
            "description": "",
            "maxLength": 254,
            "title": "Email Address",
            "type": "string"
        },
        "isActive": {
            "default": true,
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "externalSource": {
            "description": "Name of the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "Unique identifier within the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source ID",
            "type": "string"
        },
        "isServiceAccount": {
            "default": false,
            "description": "Whether the user is a technical service account",
            "title": "Is service account?",
            "type": "boolean"
        },
        "title": {
            "description": "Personal title of the user",
            "maxLength": 100,
            "title": "Title",
            "type": "string"
        },
        "organization": {
            "description": "Organization to which the user belongs to",
            "maxLength": 100,
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "Department within an organization to which the user belongs to",
            "maxLength": 100,
            "title": "Department",
            "type": "string"
        },
        "accessLevel": {
            "default": 0,
            "description": "Level of access of the user in terms of permissions",
            "title": "Access level",
            "type": "integer"
        },
        "shareable": {
            "description": "Whether user has consented to its data to be shared with other Onconova instances",
            "title": "Shareable",
            "type": "boolean"
        }
    },
    "required": [
        "username"
    ],
    "title": "UserCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "c7601868-753a-43ed-b5e1-8a2ca11b670e",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/users/{userId}

Get User By Id

Description

Retrieve a user instance by its unique ID.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
userId path string No

Response 200 OK

{
    "lastLogin": "2022-04-13T15:42:05.901Z",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "isActive": true,
    "externalSource": "string",
    "externalSourceId": "string",
    "isServiceAccount": true,
    "title": "string",
    "organization": "string",
    "department": "string",
    "accessLevel": 0,
    "shareable": true,
    "id": "27237ec2-06d8-4214-a24a-c1a647374633",
    "fullName": "string",
    "role": "External",
    "canViewCases": true,
    "canViewProjects": true,
    "canViewCohorts": true,
    "canViewUsers": true,
    "canViewDatasets": true,
    "canManageCases": true,
    "canExportData": true,
    "canManageProjects": true,
    "canManageUsers": true,
    "isSystemAdmin": true,
    "isProvided": true,
    "provider": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "lastLogin": {
            "description": "",
            "format": "date-time",
            "title": "Last Login",
            "type": "string"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "title": "Username",
            "type": "string"
        },
        "firstName": {
            "description": "",
            "maxLength": 150,
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "",
            "maxLength": 150,
            "title": "Last Name",
            "type": "string"
        },
        "email": {
            "description": "",
            "maxLength": 254,
            "title": "Email Address",
            "type": "string"
        },
        "isActive": {
            "default": true,
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "externalSource": {
            "description": "Name of the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "Unique identifier within the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source ID",
            "type": "string"
        },
        "isServiceAccount": {
            "default": false,
            "description": "Whether the user is a technical service account",
            "title": "Is service account?",
            "type": "boolean"
        },
        "title": {
            "description": "Personal title of the user",
            "maxLength": 100,
            "title": "Title",
            "type": "string"
        },
        "organization": {
            "description": "Organization to which the user belongs to",
            "maxLength": 100,
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "Department within an organization to which the user belongs to",
            "maxLength": 100,
            "title": "Department",
            "type": "string"
        },
        "accessLevel": {
            "default": 0,
            "description": "Level of access of the user in terms of permissions",
            "title": "Access level",
            "type": "integer"
        },
        "shareable": {
            "description": "Whether user has consented to its data to be shared with other Onconova instances",
            "title": "Shareable",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "fullName": {
            "description": "The user's full name.",
            "title": "Full Name",
            "type": "string"
        },
        "role": {
            "$ref": "#/components/schemas/AccessRoles",
            "description": "The user's assigned access role.",
            "title": "Role"
        },
        "canViewCases": {
            "description": "Permission to view cases.",
            "title": "View Cases",
            "type": "boolean"
        },
        "canViewProjects": {
            "description": "Permission to view projects.",
            "title": "View Projects",
            "type": "boolean"
        },
        "canViewCohorts": {
            "description": "Permission to view cohorts.",
            "title": "View Cohorts",
            "type": "boolean"
        },
        "canViewUsers": {
            "description": "Permission to view other user accounts.",
            "title": "View Users",
            "type": "boolean"
        },
        "canViewDatasets": {
            "description": "Permission to view available datasets.",
            "title": "View Datasets",
            "type": "boolean"
        },
        "canManageCases": {
            "description": "Permission to manage cases.",
            "title": "Manage Cases",
            "type": "boolean"
        },
        "canExportData": {
            "description": "Permission to export data out of the system.",
            "title": "Export Data",
            "type": "boolean"
        },
        "canManageProjects": {
            "description": "Permission to manage projects.",
            "title": "Manage Projects",
            "type": "boolean"
        },
        "canManageUsers": {
            "description": "Permission to create and manage users.",
            "title": "Manage Users",
            "type": "boolean"
        },
        "isSystemAdmin": {
            "description": "Whether the user is a system administrator.",
            "title": "System Administrator",
            "type": "boolean"
        },
        "isProvided": {
            "description": "Indicates whether the user account is externally provided.",
            "title": "Is Provided",
            "type": "boolean"
        },
        "provider": {
            "description": "The external authentication provider, if applicable.",
            "title": "Provider",
            "type": "string"
        }
    },
    "required": [
        "username",
        "id",
        "fullName",
        "role",
        "canViewCases",
        "canViewProjects",
        "canViewCohorts",
        "canViewUsers",
        "canViewDatasets",
        "canManageCases",
        "canExportData",
        "canManageProjects",
        "canManageUsers",
        "isSystemAdmin",
        "isProvided"
    ],
    "title": "User",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/users/{userId}

Update User

Description

Updates the specified user's information using the provided payload.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
userId path string No

Request body

{
    "lastLogin": "2022-04-13T15:42:05.901Z",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "isActive": true,
    "externalSource": "string",
    "externalSourceId": "string",
    "isServiceAccount": true,
    "title": "string",
    "organization": "string",
    "department": "string",
    "accessLevel": 0,
    "shareable": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "lastLogin": {
            "description": "",
            "format": "date-time",
            "title": "Last Login",
            "type": "string"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "title": "Username",
            "type": "string"
        },
        "firstName": {
            "description": "",
            "maxLength": 150,
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "",
            "maxLength": 150,
            "title": "Last Name",
            "type": "string"
        },
        "email": {
            "description": "",
            "maxLength": 254,
            "title": "Email Address",
            "type": "string"
        },
        "isActive": {
            "default": true,
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "externalSource": {
            "description": "Name of the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "Unique identifier within the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source ID",
            "type": "string"
        },
        "isServiceAccount": {
            "default": false,
            "description": "Whether the user is a technical service account",
            "title": "Is service account?",
            "type": "boolean"
        },
        "title": {
            "description": "Personal title of the user",
            "maxLength": 100,
            "title": "Title",
            "type": "string"
        },
        "organization": {
            "description": "Organization to which the user belongs to",
            "maxLength": 100,
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "Department within an organization to which the user belongs to",
            "maxLength": 100,
            "title": "Department",
            "type": "string"
        },
        "accessLevel": {
            "default": 0,
            "description": "Level of access of the user in terms of permissions",
            "title": "Access level",
            "type": "integer"
        },
        "shareable": {
            "description": "Whether user has consented to its data to be shared with other Onconova instances",
            "title": "Shareable",
            "type": "boolean"
        }
    },
    "required": [
        "username"
    ],
    "title": "UserCreate",
    "type": "object"
}

Response 200 OK

{
    "lastLogin": "2022-04-13T15:42:05.901Z",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "isActive": true,
    "externalSource": "string",
    "externalSourceId": "string",
    "isServiceAccount": true,
    "title": "string",
    "organization": "string",
    "department": "string",
    "accessLevel": 0,
    "shareable": true,
    "id": "801be834-2041-4872-8350-2ccab7370c78",
    "fullName": "string",
    "role": "External",
    "canViewCases": true,
    "canViewProjects": true,
    "canViewCohorts": true,
    "canViewUsers": true,
    "canViewDatasets": true,
    "canManageCases": true,
    "canExportData": true,
    "canManageProjects": true,
    "canManageUsers": true,
    "isSystemAdmin": true,
    "isProvided": true,
    "provider": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "lastLogin": {
            "description": "",
            "format": "date-time",
            "title": "Last Login",
            "type": "string"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "title": "Username",
            "type": "string"
        },
        "firstName": {
            "description": "",
            "maxLength": 150,
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "",
            "maxLength": 150,
            "title": "Last Name",
            "type": "string"
        },
        "email": {
            "description": "",
            "maxLength": 254,
            "title": "Email Address",
            "type": "string"
        },
        "isActive": {
            "default": true,
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "externalSource": {
            "description": "Name of the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "Unique identifier within the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source ID",
            "type": "string"
        },
        "isServiceAccount": {
            "default": false,
            "description": "Whether the user is a technical service account",
            "title": "Is service account?",
            "type": "boolean"
        },
        "title": {
            "description": "Personal title of the user",
            "maxLength": 100,
            "title": "Title",
            "type": "string"
        },
        "organization": {
            "description": "Organization to which the user belongs to",
            "maxLength": 100,
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "Department within an organization to which the user belongs to",
            "maxLength": 100,
            "title": "Department",
            "type": "string"
        },
        "accessLevel": {
            "default": 0,
            "description": "Level of access of the user in terms of permissions",
            "title": "Access level",
            "type": "integer"
        },
        "shareable": {
            "description": "Whether user has consented to its data to be shared with other Onconova instances",
            "title": "Shareable",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "fullName": {
            "description": "The user's full name.",
            "title": "Full Name",
            "type": "string"
        },
        "role": {
            "$ref": "#/components/schemas/AccessRoles",
            "description": "The user's assigned access role.",
            "title": "Role"
        },
        "canViewCases": {
            "description": "Permission to view cases.",
            "title": "View Cases",
            "type": "boolean"
        },
        "canViewProjects": {
            "description": "Permission to view projects.",
            "title": "View Projects",
            "type": "boolean"
        },
        "canViewCohorts": {
            "description": "Permission to view cohorts.",
            "title": "View Cohorts",
            "type": "boolean"
        },
        "canViewUsers": {
            "description": "Permission to view other user accounts.",
            "title": "View Users",
            "type": "boolean"
        },
        "canViewDatasets": {
            "description": "Permission to view available datasets.",
            "title": "View Datasets",
            "type": "boolean"
        },
        "canManageCases": {
            "description": "Permission to manage cases.",
            "title": "Manage Cases",
            "type": "boolean"
        },
        "canExportData": {
            "description": "Permission to export data out of the system.",
            "title": "Export Data",
            "type": "boolean"
        },
        "canManageProjects": {
            "description": "Permission to manage projects.",
            "title": "Manage Projects",
            "type": "boolean"
        },
        "canManageUsers": {
            "description": "Permission to create and manage users.",
            "title": "Manage Users",
            "type": "boolean"
        },
        "isSystemAdmin": {
            "description": "Whether the user is a system administrator.",
            "title": "System Administrator",
            "type": "boolean"
        },
        "isProvided": {
            "description": "Indicates whether the user account is externally provided.",
            "title": "Is Provided",
            "type": "boolean"
        },
        "provider": {
            "description": "The external authentication provider, if applicable.",
            "title": "Provider",
            "type": "string"
        }
    },
    "required": [
        "username",
        "id",
        "fullName",
        "role",
        "canViewCases",
        "canViewProjects",
        "canViewCohorts",
        "canViewUsers",
        "canViewDatasets",
        "canManageCases",
        "canExportData",
        "canManageProjects",
        "canManageUsers",
        "isSystemAdmin",
        "isProvided"
    ],
    "title": "User",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/users/{userId}/profile

Update User Profile

Description

Updates the profile information of a user with the given user ID.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
userId path string No

Request body

{
    "firstName": "string",
    "lastName": "string",
    "organization": "string",
    "department": "string",
    "title": "string",
    "email": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Schema representing a user's profile information.\n\nAttributes:\n    firstName (Optional[str]): The user's given name. Accepts either 'firstName' or 'first_name' as input.\n    lastName (Optional[str]): The user's surname. Accepts either 'lastName' or 'last_name' as input.\n    organization (Optional[str]): The user's affiliated organization.\n    department (Optional[str]): The user's department within the organization.\n    title (Optional[str]): The user's job title or position.\n    email (str): The user's primary email address.",
    "properties": {
        "firstName": {
            "description": "The user's given name.",
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "The user's surname.",
            "title": "Last Name",
            "type": "string"
        },
        "organization": {
            "description": "The user's affiliated organization.",
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "The user's department within the organization.",
            "title": "Department",
            "type": "string"
        },
        "title": {
            "description": "The user's job title or position.",
            "title": "Job Title",
            "type": "string"
        },
        "email": {
            "description": "The user's primary email address.",
            "title": "Email Address",
            "type": "string"
        }
    },
    "required": [
        "firstName",
        "lastName",
        "email"
    ],
    "title": "UserProfile",
    "type": "object"
}

Response 201 Created

{
    "lastLogin": "2022-04-13T15:42:05.901Z",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "isActive": true,
    "externalSource": "string",
    "externalSourceId": "string",
    "isServiceAccount": true,
    "title": "string",
    "organization": "string",
    "department": "string",
    "accessLevel": 0,
    "shareable": true,
    "id": "8191e4ef-6871-4cb1-9aa2-836c74c86a73",
    "fullName": "string",
    "role": "External",
    "canViewCases": true,
    "canViewProjects": true,
    "canViewCohorts": true,
    "canViewUsers": true,
    "canViewDatasets": true,
    "canManageCases": true,
    "canExportData": true,
    "canManageProjects": true,
    "canManageUsers": true,
    "isSystemAdmin": true,
    "isProvided": true,
    "provider": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "lastLogin": {
            "description": "",
            "format": "date-time",
            "title": "Last Login",
            "type": "string"
        },
        "username": {
            "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength": 150,
            "title": "Username",
            "type": "string"
        },
        "firstName": {
            "description": "",
            "maxLength": 150,
            "title": "First Name",
            "type": "string"
        },
        "lastName": {
            "description": "",
            "maxLength": 150,
            "title": "Last Name",
            "type": "string"
        },
        "email": {
            "description": "",
            "maxLength": 254,
            "title": "Email Address",
            "type": "string"
        },
        "isActive": {
            "default": true,
            "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
            "title": "Active",
            "type": "boolean"
        },
        "externalSource": {
            "description": "Name of the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "Unique identifier within the source from which the user originated, if imported",
            "maxLength": 500,
            "title": "External source ID",
            "type": "string"
        },
        "isServiceAccount": {
            "default": false,
            "description": "Whether the user is a technical service account",
            "title": "Is service account?",
            "type": "boolean"
        },
        "title": {
            "description": "Personal title of the user",
            "maxLength": 100,
            "title": "Title",
            "type": "string"
        },
        "organization": {
            "description": "Organization to which the user belongs to",
            "maxLength": 100,
            "title": "Organization",
            "type": "string"
        },
        "department": {
            "description": "Department within an organization to which the user belongs to",
            "maxLength": 100,
            "title": "Department",
            "type": "string"
        },
        "accessLevel": {
            "default": 0,
            "description": "Level of access of the user in terms of permissions",
            "title": "Access level",
            "type": "integer"
        },
        "shareable": {
            "description": "Whether user has consented to its data to be shared with other Onconova instances",
            "title": "Shareable",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "fullName": {
            "description": "The user's full name.",
            "title": "Full Name",
            "type": "string"
        },
        "role": {
            "$ref": "#/components/schemas/AccessRoles",
            "description": "The user's assigned access role.",
            "title": "Role"
        },
        "canViewCases": {
            "description": "Permission to view cases.",
            "title": "View Cases",
            "type": "boolean"
        },
        "canViewProjects": {
            "description": "Permission to view projects.",
            "title": "View Projects",
            "type": "boolean"
        },
        "canViewCohorts": {
            "description": "Permission to view cohorts.",
            "title": "View Cohorts",
            "type": "boolean"
        },
        "canViewUsers": {
            "description": "Permission to view other user accounts.",
            "title": "View Users",
            "type": "boolean"
        },
        "canViewDatasets": {
            "description": "Permission to view available datasets.",
            "title": "View Datasets",
            "type": "boolean"
        },
        "canManageCases": {
            "description": "Permission to manage cases.",
            "title": "Manage Cases",
            "type": "boolean"
        },
        "canExportData": {
            "description": "Permission to export data out of the system.",
            "title": "Export Data",
            "type": "boolean"
        },
        "canManageProjects": {
            "description": "Permission to manage projects.",
            "title": "Manage Projects",
            "type": "boolean"
        },
        "canManageUsers": {
            "description": "Permission to create and manage users.",
            "title": "Manage Users",
            "type": "boolean"
        },
        "isSystemAdmin": {
            "description": "Whether the user is a system administrator.",
            "title": "System Administrator",
            "type": "boolean"
        },
        "isProvided": {
            "description": "Indicates whether the user account is externally provided.",
            "title": "Is Provided",
            "type": "boolean"
        },
        "provider": {
            "description": "The external authentication provider, if applicable.",
            "title": "Provider",
            "type": "string"
        }
    },
    "required": [
        "username",
        "id",
        "fullName",
        "role",
        "canViewCases",
        "canViewProjects",
        "canViewCohorts",
        "canViewUsers",
        "canViewDatasets",
        "canManageCases",
        "canExportData",
        "canManageProjects",
        "canManageUsers",
        "isSystemAdmin",
        "isProvided"
    ],
    "title": "User",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/users/{userId}/password

Update User Password

Description

Updates the password for a specified user.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
userId path string No

Request body

{
    "oldPassword": "string",
    "newPassword": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Schema for user password reset operation.\n\nAttributes:\n    oldPassword (str): The user's current password.\n    newPassword (str): The user's new password to be set.",
    "properties": {
        "oldPassword": {
            "description": "The user's current password.",
            "title": "Old Password",
            "type": "string"
        },
        "newPassword": {
            "description": "The user's new password to be set.",
            "title": "New Password",
            "type": "string"
        }
    },
    "required": [
        "oldPassword",
        "newPassword"
    ],
    "title": "UserPasswordReset",
    "type": "object"
}

Response 201 Created

{
    "id": "e43a836a-d69f-4f60-bb3b-876a4b6f3f08",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/users/{userId}/password/reset

Reset User Password

Description

Resets the password for the specified user.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
password query string No
userId path string No

Response 201 Created

{
    "id": "580cfb95-3408-40bc-ae68-986ba03b2c11",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/users/{userId}/events

Get User Events

Description

Retrieves the event history for the specified user.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
userId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Projects


GET /api/v1/projects

Get All Projects Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
clinicalCenters query string No Clinical Centers - Filter for full text matches
clinicalCenters.anyOf query array No Clinical Centers - Filter for entries where at least one reference matches the query
clinicalCenters.beginsWith query string No Clinical Centers - Filter for entries starting with the text
clinicalCenters.contains query string No Clinical Centers - Filter for partial text matches
clinicalCenters.endsWith query string No Clinical Centers - Filter for entries ending with the text
clinicalCenters.not query string No Clinical Centers - Filter for full text mismatches
clinicalCenters.not.anyOf query array No Clinical Centers - Filter for entries where at least one reference mismatches the query
clinicalCenters.not.beginsWith query string No Clinical Centers - Filter for entries not starting with the text
clinicalCenters.not.contains query string No Clinical Centers - Filter for partial text mismatches
clinicalCenters.not.endsWith query string No Clinical Centers - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
dataConstraints.exists query boolean No Data constraints - Filter for entries with a value
dataConstraints.not.exists query boolean No Data constraints - Filter for entries without a value
ethicsApprovalNumber query string No Ethics approval number - Filter for full text matches
ethicsApprovalNumber.anyOf query array No Ethics approval number - Filter for entries where at least one reference matches the query
ethicsApprovalNumber.beginsWith query string No Ethics approval number - Filter for entries starting with the text
ethicsApprovalNumber.contains query string No Ethics approval number - Filter for partial text matches
ethicsApprovalNumber.endsWith query string No Ethics approval number - Filter for entries ending with the text
ethicsApprovalNumber.not query string No Ethics approval number - Filter for full text mismatches
ethicsApprovalNumber.not.anyOf query array No Ethics approval number - Filter for entries where at least one reference mismatches the query
ethicsApprovalNumber.not.beginsWith query string No Ethics approval number - Filter for entries not starting with the text
ethicsApprovalNumber.not.contains query string No Ethics approval number - Filter for partial text mismatches
ethicsApprovalNumber.not.endsWith query string No Ethics approval number - Filter for entries not ending with the text
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
leader.username query string No Project leader - Filter for username matches
leader.username.anyOf query array No Project leader - Filter for entries where at least one reference mismatches the query
leader.username.not query string No Project leader - Filter for username mismatches
leader.username.not.anyOf query string No Project leader - Filter for entries where at least one reference matches the query
limit query integer 10 No
members.exists query boolean No Project members - Filter for entries with a value
members.not.exists query boolean No Project members - Filter for entries without a value
members.username query string No Project members - Filter for username matches
members.username.anyOf query array No Project members - Filter for entries where at least one reference mismatches the query
members.username.not query string No Project members - Filter for username mismatches
members.username.not.anyOf query string No Project members - Filter for entries where at least one reference matches the query
offset query integer 0 No
ordering query None No
status query None No Project status - Filter for single value choice
status.anyOf query array No Project status - ('Filter for excluding a subset of value choices',)
status.exists query boolean No Project status - Filter for entries with a value
status.not query None No Project status - ('Filter for all but a single value choice',)
status.not.exists query boolean No Project status - Filter for entries without a value
summary query string No Project description - Filter for full text matches
summary.anyOf query array No Project description - Filter for entries where at least one reference matches the query
summary.beginsWith query string No Project description - Filter for entries starting with the text
summary.contains query string No Project description - Filter for partial text matches
summary.endsWith query string No Project description - Filter for entries ending with the text
summary.not query string No Project description - Filter for full text mismatches
summary.not.anyOf query array No Project description - Filter for entries where at least one reference mismatches the query
summary.not.beginsWith query string No Project description - Filter for entries not starting with the text
summary.not.contains query string No Project description - Filter for partial text mismatches
summary.not.endsWith query string No Project description - Filter for entries not ending with the text
title query string No Project title - Filter for full text matches
title.anyOf query array No Project title - Filter for entries where at least one reference matches the query
title.beginsWith query string No Project title - Filter for entries starting with the text
title.contains query string No Project title - Filter for partial text matches
title.endsWith query string No Project title - Filter for entries ending with the text
title.not query string No Project title - Filter for full text mismatches
title.not.anyOf query array No Project title - Filter for entries where at least one reference mismatches the query
title.not.beginsWith query string No Project title - Filter for entries not starting with the text
title.not.contains query string No Project title - Filter for partial text mismatches
title.not.endsWith query string No Project title - Filter for entries not ending with the text
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": "3fcbaf08-e460-4ad1-b959-0a95ee5fd80b",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "leader": "string",
            "clinicalCenters": [
                "string"
            ],
            "title": "string",
            "summary": "string",
            "ethicsApprovalNumber": "string",
            "status": null,
            "dataConstraints": {},
            "members": [
                "string"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Project"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Project]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/projects

Create Project

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "leader": "string",
    "clinicalCenters": [
        "string"
    ],
    "title": "string",
    "summary": "string",
    "ethicsApprovalNumber": "string",
    "status": null,
    "dataConstraints": {},
    "members": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "leader": {
            "description": "User responsible for the project and its members",
            "title": "Project leader",
            "type": "string"
        },
        "clinicalCenters": {
            "description": "Clinical centers that are part of the project",
            "items": {
                "type": "string"
            },
            "maxItems": 100,
            "title": "Clinical Centers",
            "type": "array"
        },
        "title": {
            "description": "Title of the project",
            "maxLength": 200,
            "title": "Project title",
            "type": "string"
        },
        "summary": {
            "description": "Description of the project",
            "title": "Project description",
            "type": "string"
        },
        "ethicsApprovalNumber": {
            "description": "Ethics approval number of the project",
            "maxLength": 100,
            "title": "Ethics approval number",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectStatusChoices"
                }
            ],
            "default": "planned",
            "description": "Status of the project",
            "title": "Project status"
        },
        "dataConstraints": {
            "additionalProperties": true,
            "description": "Data constraints of the project",
            "title": "Data constraints",
            "type": "object"
        },
        "members": {
            "description": "Users that are part of the project",
            "items": {
                "type": "string"
            },
            "title": "Project members",
            "type": "array"
        }
    },
    "required": [
        "leader",
        "clinicalCenters",
        "title",
        "summary",
        "ethicsApprovalNumber"
    ],
    "title": "ProjectCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "15f5d224-423f-4cc3-8334-51905d9e6943",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}

Get Project By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
projectId path string No

Response 200 OK

{
    "id": "7cdeaead-c33b-4a2a-babd-cd6f7ace3617",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "leader": "string",
    "clinicalCenters": [
        "string"
    ],
    "title": "string",
    "summary": "string",
    "ethicsApprovalNumber": "string",
    "status": null,
    "dataConstraints": {},
    "members": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "leader": {
            "description": "User responsible for the project and its members",
            "title": "Project leader",
            "type": "string"
        },
        "clinicalCenters": {
            "description": "Clinical centers that are part of the project",
            "items": {
                "type": "string"
            },
            "maxItems": 100,
            "title": "Clinical Centers",
            "type": "array"
        },
        "title": {
            "description": "Title of the project",
            "maxLength": 200,
            "title": "Project title",
            "type": "string"
        },
        "summary": {
            "description": "Description of the project",
            "title": "Project description",
            "type": "string"
        },
        "ethicsApprovalNumber": {
            "description": "Ethics approval number of the project",
            "maxLength": 100,
            "title": "Ethics approval number",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectStatusChoices"
                }
            ],
            "default": "planned",
            "description": "Status of the project",
            "title": "Project status"
        },
        "dataConstraints": {
            "additionalProperties": true,
            "description": "Data constraints of the project",
            "title": "Data constraints",
            "type": "object"
        },
        "members": {
            "description": "Users that are part of the project",
            "items": {
                "type": "string"
            },
            "title": "Project members",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "leader",
        "clinicalCenters",
        "title",
        "summary",
        "ethicsApprovalNumber"
    ],
    "title": "Project",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/projects/{projectId}

Update Project

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
projectId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "leader": "string",
    "clinicalCenters": [
        "string"
    ],
    "title": "string",
    "summary": "string",
    "ethicsApprovalNumber": "string",
    "status": null,
    "dataConstraints": {},
    "members": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "leader": {
            "description": "User responsible for the project and its members",
            "title": "Project leader",
            "type": "string"
        },
        "clinicalCenters": {
            "description": "Clinical centers that are part of the project",
            "items": {
                "type": "string"
            },
            "maxItems": 100,
            "title": "Clinical Centers",
            "type": "array"
        },
        "title": {
            "description": "Title of the project",
            "maxLength": 200,
            "title": "Project title",
            "type": "string"
        },
        "summary": {
            "description": "Description of the project",
            "title": "Project description",
            "type": "string"
        },
        "ethicsApprovalNumber": {
            "description": "Ethics approval number of the project",
            "maxLength": 100,
            "title": "Ethics approval number",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectStatusChoices"
                }
            ],
            "default": "planned",
            "description": "Status of the project",
            "title": "Project status"
        },
        "dataConstraints": {
            "additionalProperties": true,
            "description": "Data constraints of the project",
            "title": "Data constraints",
            "type": "object"
        },
        "members": {
            "description": "Users that are part of the project",
            "items": {
                "type": "string"
            },
            "title": "Project members",
            "type": "array"
        }
    },
    "required": [
        "leader",
        "clinicalCenters",
        "title",
        "summary",
        "ethicsApprovalNumber"
    ],
    "title": "ProjectCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "36cac264-fc13-4388-a40e-969c5e7c922b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/projects/{projectId}

Delete Project

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
projectId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/history/events

Get All Project History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
projectId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/history/events/{eventId}

Get Project History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
projectId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/projects/{projectId}/history/events/{eventId}/reversion

Revert Project To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
projectId path string No

Response 201 Created

{
    "id": "59a747d3-f225-4682-bde4-89705433513b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants

Get All Project Data Manager Grant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
memberId path string No
offset query integer 0 No
ordering query None No
projectId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": "b6a53624-7ccd-4803-8396-020c69d75655",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "revoked": true,
            "validityPeriod": {
                "start": "2022-04-13",
                "end": "2022-04-13"
            },
            "isValid": true,
            "member": "string",
            "projectId": "48d66ad3-7e36-4ed9-aeb5-8d526271d840"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/ProjectDataManagerGrant"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[ProjectDataManagerGrant]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/projects/{projectId}/members/{memberId}/data-management/grants

Create Project Data Manager Grant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
memberId path string No
projectId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "revoked": true,
    "validityPeriod": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "revoked": {
            "default": false,
            "description": "A flag that indicated whether the authorization has been revoked",
            "title": "Revoked",
            "type": "boolean"
        },
        "validityPeriod": {
            "$ref": "#/components/schemas/Period",
            "description": "Period of validity",
            "title": "Validity period"
        }
    },
    "required": [
        "validityPeriod"
    ],
    "title": "ProjectDataManagerGrantCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "7d0f2b3b-6e01-4e5d-954f-739c0bea8a49",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}

Check Project Data Manager Grant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
grantId path string No
memberId path string No
projectId path string No

Response 200 OK

{
    "id": "bff431a1-cf7c-48cc-b3d6-ae7cc0bc9d14",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "revoked": true,
    "validityPeriod": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "isValid": true,
    "member": "string",
    "projectId": "eb4f61b1-032b-4c88-9d21-15a821ed1728"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "revoked": {
            "default": false,
            "description": "A flag that indicated whether the authorization has been revoked",
            "title": "Revoked",
            "type": "boolean"
        },
        "validityPeriod": {
            "$ref": "#/components/schemas/Period",
            "description": "Period of validity",
            "title": "Validity period"
        },
        "isValid": {
            "description": "Whether the authorization grant is valid today",
            "title": "Is valid",
            "type": "boolean"
        },
        "member": {
            "description": "Manager of the project data",
            "title": "Manager",
            "type": "string"
        },
        "projectId": {
            "description": "Project under which the permission is granted",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        }
    },
    "required": [
        "id",
        "description",
        "validityPeriod",
        "isValid",
        "member",
        "projectId"
    ],
    "title": "ProjectDataManagerGrant",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}

Revoke Project Data Manager Grant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
grantId path string No
memberId path string No
projectId path string No

Response 201 Created

{
    "id": "7e5fe6a1-89db-4693-8e3a-05da21f34f3b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events

Get All Project Data Management Grant History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
grantId path string No
limit query integer 10 No
memberId path string No
offset query integer 0 No
ordering query None No
projectId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}

Get Project Data Management Grant History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
grantId path string No
memberId path string No
projectId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/projects/{projectId}/members/{memberId}/data-management/grants/{grantId}/history/events/{eventId}/reversion

Revert Project Data Management Grant To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
grantId path string No
memberId path string No
projectId path string No

Response 201 Created

{
    "id": "482b8f18-dac6-4b41-bd80-3421d26aa1e6",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Interoperability


GET /api/v1/interoperability/resources/{resourceId}

Export Resource

Description

Exports a resource identified by its UUID, serializing its data and associated metadata.

Notes:

- Creates an export event for the resource using

pghistory.create_event. - Computes a checksum of the exported data for integrity verification.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
resourceId path string No

Response 200 OK

Schema of the response body
{
    "title": "Response"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/interoperability/resources/{resourceId}/description

Resolve Resource Id

Description

Resolves a resource ID by searching across models for a matching UUID.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
resourceId path string No

Response 200 OK

"string"
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Response",
    "type": "string"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/interoperability/bundles/{caseId}

Export Case Bundle

Description

Exports a patient case bundle by retrieving the PatientCase object with the given case ID, creates an export event for the case, and returns the exported case object.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "723af081-82b2-4bc3-8340-ee4571b581d4",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "clinicalCenter": "string",
    "clinicalIdentifier": "string",
    "consentStatus": null,
    "gender": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "race": null,
    "sexAtBirth": null,
    "genderIdentity": null,
    "dateOfBirth": null,
    "vitalStatus": null,
    "dateOfDeath": "2022-04-13",
    "causeOfDeath": null,
    "endOfRecords": "2022-04-13",
    "pseudoidentifier": "string",
    "age": null,
    "overallSurvival": 10.12,
    "ageAtDiagnosis": null,
    "dataCompletionRate": 10.12,
    "contributors": [
        "string"
    ],
    "neoplasticEntities": [
        {
            "anonymized": true,
            "id": "61b63410-79e1-40d8-b4b2-0e520525ef90",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "9a56f6fc-7ba1-4e3b-b7c0-a393dbb0b97c",
            "relationship": "primary",
            "relatedPrimaryId": "03aa8f21-c13c-41ec-873c-aee0f7d9ea1d",
            "assertionDate": "2022-04-13",
            "topography": null,
            "morphology": null,
            "differentitation": null,
            "laterality": null,
            "topographyGroup": null
        }
    ],
    "stagings": [
        null
    ],
    "tumorMarkers": [
        {
            "anonymized": true,
            "id": "b300387c-0cf9-49d1-971f-610251064318",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "c63c0240-fee5-40e1-ae56-6acc2a75e8d9",
            "date": "2022-04-13",
            "analyte": null,
            "massConcentration": null,
            "arbitraryConcentration": null,
            "substanceConcentration": null,
            "fraction": null,
            "multipleOfMedian": null,
            "tumorProportionScore": null,
            "immuneCellScore": null,
            "combinedPositiveScore": null,
            "immunohistochemicalScore": null,
            "presence": null,
            "nuclearExpressionStatus": null,
            "relatedEntitiesIds": [
                "b0c54fa2-7d36-4cac-bc2b-87ca1a94cb68"
            ]
        }
    ],
    "riskAssessments": [
        {
            "anonymized": true,
            "id": "1ae60fdb-5a93-4284-ad04-2029fbf515ab",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "f6d89c11-b843-493d-86e5-30ef901ed0fe",
            "date": "2022-04-13",
            "methodology": null,
            "risk": null,
            "score": 10.12,
            "assessedEntitiesIds": [
                "f99c7caa-0647-4c39-bd53-ec5f05dec5cd"
            ]
        }
    ],
    "therapyLines": [
        {
            "anonymized": true,
            "id": "0bc784d4-bc15-47f1-9654-3fe45b1d93eb",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "4b12b16a-86ff-4987-a777-a47dd0a24c3b",
            "ordinal": 0,
            "intent": "curative",
            "progressionDate": "2022-04-13",
            "period": null,
            "label": "string",
            "progressionFreeSurvival": 10.12
        }
    ],
    "systemicTherapies": [
        {
            "anonymized": true,
            "id": "8198fb84-5dd2-4838-aa03-7ad3b79d2e39",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "33194625-90bb-463b-b62d-0e7f07cf5e7e",
            "period": {
                "start": "2022-04-13",
                "end": "2022-04-13"
            },
            "cycles": 0,
            "intent": "curative",
            "adjunctiveRole": null,
            "terminationReason": null,
            "therapyLineId": "820a7595-ba6c-4d6d-ac67-03d51f8680d4",
            "targetedEntitiesIds": [
                "ef57bee6-f25d-476c-82b4-cd09f9c6cbe3"
            ],
            "medications": [
                {
                    "id": "26021e49-bbb1-464c-bdc4-e9afbc6d72c1",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "drug": null,
                    "route": null,
                    "usedOfflabel": true,
                    "withinSoc": true,
                    "dosageMassConcentration": null,
                    "dosageMass": null,
                    "dosageVolume": null,
                    "dosageMassSurface": null,
                    "dosageRateMassConcentration": null,
                    "dosageRateMass": null,
                    "dosageRateVolume": null,
                    "dosageRateMassSurface": null
                }
            ],
            "isAdjunctive": true,
            "duration": {
                "value": 10.12,
                "unit": "string"
            }
        }
    ],
    "surgeries": [
        {
            "anonymized": true,
            "id": "fa9d3a1e-53a6-49de-882d-42168f10decb",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "6862fdf4-778a-4e2d-9bd9-7bc6e55f5e0d",
            "date": "2022-04-13",
            "procedure": null,
            "intent": "curative",
            "bodysite": null,
            "bodysiteQualifier": null,
            "bodysiteLaterality": null,
            "outcome": null,
            "therapyLineId": "949e3af6-306f-44be-b51c-d413f9d7ddf1",
            "targetedEntitiesIds": [
                "2aaf69e2-4d98-48c6-b6db-94ec6c81d906"
            ]
        }
    ],
    "radiotherapies": [
        {
            "anonymized": true,
            "id": "c371e2d3-a470-4c30-bf00-7f889b2611b8",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "528f0be2-22b8-4f53-95b5-a50af87a7cb0",
            "period": null,
            "sessions": 0,
            "intent": "curative",
            "terminationReason": null,
            "therapyLineId": "24d80300-ee5c-4de3-b85d-a2e9c6b1355d",
            "targetedEntitiesIds": [
                "3341d23e-d081-4710-ba80-b41ba5bfb725"
            ],
            "duration": null,
            "dosages": [
                {
                    "id": "2769ab4b-0a44-4419-b791-537bfdfabfc3",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "fractions": 0,
                    "dose": null,
                    "irradiatedVolume": null,
                    "irradiatedVolumeMorphology": null,
                    "irradiatedVolumeQualifier": null
                }
            ],
            "settings": [
                {
                    "id": "08f90050-460e-43e2-bec4-907b957d0ac4",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "modality": null,
                    "technique": null
                }
            ]
        }
    ],
    "adverseEvents": [
        {
            "anonymized": true,
            "id": "994adf2e-a4af-4d7e-906c-25b2d804bf87",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "3f07c5a8-b50e-40d2-9def-9d2d5ca34d2e",
            "date": "2022-04-13",
            "event": null,
            "grade": 0,
            "outcome": "resolved",
            "dateResolved": "2022-04-13",
            "suspectedCauses": [
                {
                    "id": "511fce3c-fd87-4eb0-a3e7-f8b4bb8ae0cb",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "systemicTherapyId": "fef6f684-595b-4bc6-ad86-49831f7aac37",
                    "medicationId": "a55379ef-ea8d-4c08-9de0-046a5cab5b32",
                    "radiotherapyId": "cb91b34f-b72d-4c9c-a201-42451e3ecb67",
                    "surgeryId": "c0a39b2f-17e7-4030-98fe-5df8e194cf19",
                    "causality": null
                }
            ],
            "mitigations": [
                {
                    "id": "830d0149-b4d5-4591-b193-8e749c85a9d4",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "category": "adjustment",
                    "adjustment": null,
                    "drug": null,
                    "procedure": null,
                    "management": null
                }
            ]
        }
    ],
    "treatmentResponses": [
        {
            "anonymized": true,
            "id": "3534c855-3079-4e74-8da9-2869a09118c6",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "3b360659-1039-482c-af00-f000323098ec",
            "date": "2022-04-13",
            "recist": null,
            "recistInterpreted": true,
            "methodology": null,
            "assessedEntitiesIds": [
                "eaf0119e-7be7-46ed-a1b9-b8992c81ce45"
            ],
            "assessedBodysites": null
        }
    ],
    "performanceStatus": [
        {
            "anonymized": true,
            "id": "fbf1f4ed-b298-446f-8e7a-25752315e584",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "8b47a02f-7427-4282-9404-caff639a038e",
            "date": "2022-04-13",
            "ecogScore": 0,
            "karnofskyScore": 0,
            "ecogInterpretation": null,
            "karnofskyInterpretation": null
        }
    ],
    "comorbidities": [
        {
            "anonymized": true,
            "id": "a799e6f0-4a20-46bb-8a4e-23e9fbdee5c2",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "aad9855b-a24b-45d3-b808-b155e7830e53",
            "date": "2022-04-13",
            "indexConditionId": "0a06945f-1e63-452c-b257-83d41b0499b6",
            "panel": null,
            "presentConditions": null,
            "absentConditions": null,
            "score": null
        }
    ],
    "genomicVariants": [
        {
            "anonymized": true,
            "id": "9746ddc2-a37a-4927-93dc-f861b4c4ca58",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "767bfcff-bd9e-4a53-8089-36f638ac7c28",
            "date": "2022-04-13",
            "genes": null,
            "dnaHgvs": "string",
            "rnaHgvs": "string",
            "proteinHgvs": "string",
            "assessmentDate": "2022-04-13",
            "genePanel": "string",
            "assessment": null,
            "confidence": null,
            "analysisMethod": null,
            "clinicalRelevance": null,
            "genomeAssemblyVersion": null,
            "molecularConsequence": null,
            "copyNumber": 0,
            "alleleFrequency": 10.12,
            "alleleDepth": 0,
            "zygosity": null,
            "inheritance": null,
            "coordinateSystem": null,
            "clinvar": "string",
            "isPathogenic": true,
            "isVUS": true,
            "dnaReferenceSequence": "string",
            "dnaChangePosition": 0,
            "dnaChangePositionRange": null,
            "dnaChangeType": null,
            "rnaReferenceSequence": "string",
            "rnaChangePosition": "string",
            "rnaChangeType": null,
            "proteinReferenceSequence": "string",
            "proteinChangeType": null,
            "nucleotidesLength": 0,
            "regions": [
                "string"
            ]
        }
    ],
    "genomicSignatures": [
        null
    ],
    "vitals": [
        {
            "anonymized": true,
            "id": "43f7ccd4-804c-4158-958b-5fd9df6c4856",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "1f3fab13-bf82-4af1-9b7d-d905d46af8f4",
            "date": "2022-04-13",
            "height": null,
            "weight": null,
            "bloodPressureSystolic": null,
            "bloodPressureDiastolic": null,
            "temperature": null,
            "bodyMassIndex": null
        }
    ],
    "lifestyles": [
        {
            "anonymized": true,
            "id": "9e69af2b-7b57-4bec-ad0c-25b4d6543aff",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "45aebc59-00d7-43ad-939b-68fc23ea7f2e",
            "date": "2022-04-13",
            "smokingStatus": null,
            "smokingPackyears": 10.12,
            "smokingQuited": null,
            "alcoholConsumption": null,
            "nightSleep": null,
            "recreationalDrugs": null,
            "exposures": null
        }
    ],
    "familyHistory": [
        {
            "anonymized": true,
            "id": "ab52a76d-df96-4a08-b114-3a10448fe645",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "0329a3ce-4e0c-4a4b-96db-59104af0eeef",
            "date": "2022-04-13",
            "relationship": null,
            "hadCancer": true,
            "contributedToDeath": true,
            "onsetAge": 0,
            "topography": null,
            "morphology": null
        }
    ],
    "tumorBoards": [
        null
    ],
    "completedDataCategories": {},
    "history": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ],
    "contributorsDetails": [
        {
            "anonymized": true,
            "id": "4d5d7570-4978-4c91-8e3a-6e1c4ab547a5",
            "externalSource": "string",
            "externalSourceId": "string",
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "organization": "string",
            "email": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "PatientCaseBundle aggregates all relevant patient case data for interoperability and import/export operations.\n\nThis schema extends PatientCase and organizes multiple related entities, such as neoplastic entities, stagings, tumor markers, risk assessments, therapies, surgeries, adverse events, treatment responses, performance status, comorbidities, genomic variants, genomic signatures, vitals, lifestyles, family history, tumor boards, completed data categories, and history events.\n\nThe order of properties is significant for import tools that rely on reference trees.\n\nAttributes:\n    neoplasticEntities (List[NeoplasticEntity]): List of neoplastic entities associated with the patient case.\n    stagings (List[Union[...]]): List of staging schemas (e.g., TNM, FIGO, Binet, etc.).\n    tumorMarkers (List[TumorMarkerSchema]): List of tumor marker schemas.\n    riskAssessments (List[RiskAssessment]): List of risk assessment schemas.\n    therapyLines (List[TherapyLine]): List of therapy line schemas.\n    systemicTherapies (List[SystemicTherapy]): List of systemic therapy schemas.\n    surgeries (List[Surgery]): List of surgery schemas.\n    radiotherapies (List[Radiotherapy]): List of radiotherapy schemas.\n    adverseEvents (List[AdverseEvent]): List of adverse event schemas.\n    treatmentResponses (List[TreatmentResponse]): List of treatment response schemas.\n    performanceStatus (List[PerformanceStatus]): List of performance status schemas.\n    comorbidities (List[ComorbiditiesAssessment]): List of comorbidities assessment schemas.\n    genomicVariants (List[GenomicVariant]): List of genomic variant schemas.\n    genomicSignatures (List[Union[...]]): List of genomic signature schemas (e.g., TMB, MSI, LOH, etc.).\n    vitals (List[Vitals]): List of vitals schemas.\n    lifestyles (List[Lifestyle]): List of lifestyle schemas.\n    familyHistory (List[FamilyHistory]): List of family history schemas.\n    tumorBoards (List[Union[UnspecifiedTumorBoard, MolecularTumorBoard]]): List of tumor board schemas.\n    completedDataCategories (Dict[PatientCaseDataCategories, PatientCaseDataCompletionStatus]): Mapping of data categories to their completion status.\n    history (List[HistoryEvent]): List of history events related to the patient case.\n\nMethods:\n    resolve_stagings(obj): Resolves and serializes staging data for the patient case.\n    resolve_genomicSignatures(obj): Resolves and serializes genomic signature data.\n    resolve_tumorBoards(obj): Resolves and serializes tumor board data.\n    resolve_completedDataCategories(obj): Resolves completion status for each data category.\n    resolve_history(obj): Resolves and retrieves history events for the patient case.\n\nConfig:\n    model_config: Serialization configuration (serialize_by_alias=False).",
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "clinicalCenter": {
            "description": "Medical center where the patient data originally resides",
            "maxLength": 200,
            "title": "Medical center",
            "type": "string"
        },
        "clinicalIdentifier": {
            "description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
            "maxLength": 100,
            "title": "Clinical identifier",
            "type": "string"
        },
        "consentStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Status of the general consent by the patient for the use of their data for research purposes",
            "title": "Consent status"
        },
        "gender": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Gender of the patient for legal/administrative purposes",
            "title": "Gender",
            "x-terminology": "AdministrativeGender"
        },
        "race": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Race of the patient",
            "title": "Race",
            "x-terminology": "Race"
        },
        "sexAtBirth": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Sex assigned at birth",
            "title": "Birth sex",
            "x-terminology": "BirthSex"
        },
        "genderIdentity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The patient's innate sense of their gender as reported",
            "title": "Gender identity",
            "x-terminology": "GenderIdentity"
        },
        "dateOfBirth": {
            "anyOf": [
                {
                    "format": "date",
                    "type": "string"
                },
                {
                    "const": "*************",
                    "type": "string"
                }
            ],
            "description": "Date of birth of the patient",
            "title": "Date of birth"
        },
        "vitalStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Whether the patient is known to be alive or decaeased or is unknkown.",
            "title": "Vital status"
        },
        "dateOfDeath": {
            "description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of death",
            "type": "string"
        },
        "causeOfDeath": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the cause of death.",
            "title": "Cause of death",
            "x-terminology": "CauseOfDeath"
        },
        "endOfRecords": {
            "description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
            "format": "date",
            "title": "End of records",
            "type": "string"
        },
        "pseudoidentifier": {
            "description": "Pseudoidentifier of the patient",
            "maxLength": 40,
            "title": "Pseudoidentifier",
            "type": "string"
        },
        "age": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years",
            "title": "Age"
        },
        "overallSurvival": {
            "description": "Overall survival of the patient since diagnosis",
            "title": "Overall survival",
            "type": "number"
        },
        "ageAtDiagnosis": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years at the time of the initial diagnosis",
            "title": "Age at diagnosis"
        },
        "dataCompletionRate": {
            "description": "Percentage indicating the completeness of a case in terms of its data.",
            "title": "Data completion rate",
            "type": "number"
        },
        "contributors": {
            "description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
            "items": {
                "type": "string"
            },
            "title": "Data contributors",
            "type": "array"
        },
        "neoplasticEntities": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/NeoplasticEntity"
            },
            "title": "Neoplasticentities",
            "type": "array"
        },
        "stagings": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/TNMStaging"
                    },
                    {
                        "$ref": "#/components/schemas/FIGOStaging"
                    },
                    {
                        "$ref": "#/components/schemas/BinetStaging"
                    },
                    {
                        "$ref": "#/components/schemas/RaiStaging"
                    },
                    {
                        "$ref": "#/components/schemas/BreslowDepth"
                    },
                    {
                        "$ref": "#/components/schemas/ClarkStaging"
                    },
                    {
                        "$ref": "#/components/schemas/ISSStaging"
                    },
                    {
                        "$ref": "#/components/schemas/RISSStaging"
                    },
                    {
                        "$ref": "#/components/schemas/GleasonGrade"
                    },
                    {
                        "$ref": "#/components/schemas/INSSStage"
                    },
                    {
                        "$ref": "#/components/schemas/INRGSSStage"
                    },
                    {
                        "$ref": "#/components/schemas/WilmsStage"
                    },
                    {
                        "$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
                    },
                    {
                        "$ref": "#/components/schemas/LymphomaStaging"
                    }
                ]
            },
            "title": "Stagings",
            "type": "array"
        },
        "tumorMarkers": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TumorMarker"
            },
            "title": "Tumormarkers",
            "type": "array"
        },
        "riskAssessments": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/RiskAssessment"
            },
            "title": "Riskassessments",
            "type": "array"
        },
        "therapyLines": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TherapyLine"
            },
            "title": "Therapylines",
            "type": "array"
        },
        "systemicTherapies": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/SystemicTherapy"
            },
            "title": "Systemictherapies",
            "type": "array"
        },
        "surgeries": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Surgery"
            },
            "title": "Surgeries",
            "type": "array"
        },
        "radiotherapies": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Radiotherapy"
            },
            "title": "Radiotherapies",
            "type": "array"
        },
        "adverseEvents": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/AdverseEvent"
            },
            "title": "Adverseevents",
            "type": "array"
        },
        "treatmentResponses": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TreatmentResponse"
            },
            "title": "Treatmentresponses",
            "type": "array"
        },
        "performanceStatus": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/PerformanceStatus"
            },
            "title": "Performancestatus",
            "type": "array"
        },
        "comorbidities": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/ComorbiditiesAssessment"
            },
            "title": "Comorbidities",
            "type": "array"
        },
        "genomicVariants": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/GenomicVariant"
            },
            "title": "Genomicvariants",
            "type": "array"
        },
        "genomicSignatures": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/TumorMutationalBurden"
                    },
                    {
                        "$ref": "#/components/schemas/MicrosatelliteInstability"
                    },
                    {
                        "$ref": "#/components/schemas/LossOfHeterozygosity"
                    },
                    {
                        "$ref": "#/components/schemas/HomologousRecombinationDeficiency"
                    },
                    {
                        "$ref": "#/components/schemas/TumorNeoantigenBurden"
                    },
                    {
                        "$ref": "#/components/schemas/AneuploidScore"
                    }
                ]
            },
            "title": "Genomicsignatures",
            "type": "array"
        },
        "vitals": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Vitals"
            },
            "title": "Vitals",
            "type": "array"
        },
        "lifestyles": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Lifestyle"
            },
            "title": "Lifestyles",
            "type": "array"
        },
        "familyHistory": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/FamilyHistory"
            },
            "title": "Familyhistory",
            "type": "array"
        },
        "tumorBoards": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/UnspecifiedTumorBoard"
                    },
                    {
                        "$ref": "#/components/schemas/MolecularTumorBoard"
                    }
                ]
            },
            "title": "Tumorboards",
            "type": "array"
        },
        "completedDataCategories": {
            "additionalProperties": {
                "$ref": "#/components/schemas/PatientCaseDataCompletionStatus"
            },
            "propertyNames": {
                "$ref": "#/components/schemas/PatientCaseDataCategoryChoices"
            },
            "title": "Completeddatacategories",
            "type": "object"
        },
        "history": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "History",
            "type": "array"
        },
        "contributorsDetails": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/UserExport"
            },
            "title": "Contributorsdetails",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "clinicalCenter",
        "clinicalIdentifier",
        "gender",
        "dateOfBirth",
        "pseudoidentifier",
        "age",
        "dataCompletionRate",
        "contributors",
        "completedDataCategories"
    ],
    "title": "PatientCaseBundle",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/interoperability/bundles

Import Case Bundle

Description

Imports a patient case bundle into the database, handling conflicts based on the specified resolution strategy.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
conflict query None No

Request body

{
    "anonymized": true,
    "id": "14d97c77-59e9-4788-8320-e0a22d7d0d01",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "clinicalCenter": "string",
    "clinicalIdentifier": "string",
    "consentStatus": null,
    "gender": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "race": null,
    "sexAtBirth": null,
    "genderIdentity": null,
    "dateOfBirth": null,
    "vitalStatus": null,
    "dateOfDeath": "2022-04-13",
    "causeOfDeath": null,
    "endOfRecords": "2022-04-13",
    "pseudoidentifier": "string",
    "age": null,
    "overallSurvival": 10.12,
    "ageAtDiagnosis": null,
    "dataCompletionRate": 10.12,
    "contributors": [
        "string"
    ],
    "neoplasticEntities": [
        {
            "anonymized": true,
            "id": "885d78d4-63b7-43ff-aca2-7078cb1e4586",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "5f2dd46a-f047-4337-b428-e9ca1e39a6eb",
            "relationship": "primary",
            "relatedPrimaryId": "00a526b5-ebe1-4f66-bf78-ba25f527509a",
            "assertionDate": "2022-04-13",
            "topography": null,
            "morphology": null,
            "differentitation": null,
            "laterality": null,
            "topographyGroup": null
        }
    ],
    "stagings": [
        null
    ],
    "tumorMarkers": [
        {
            "anonymized": true,
            "id": "6d4f12c6-d20d-4be1-9768-bf8307b5de5c",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "f1f5c20d-880a-4120-8dd3-f6e2e1092e6f",
            "date": "2022-04-13",
            "analyte": null,
            "massConcentration": null,
            "arbitraryConcentration": null,
            "substanceConcentration": null,
            "fraction": null,
            "multipleOfMedian": null,
            "tumorProportionScore": null,
            "immuneCellScore": null,
            "combinedPositiveScore": null,
            "immunohistochemicalScore": null,
            "presence": null,
            "nuclearExpressionStatus": null,
            "relatedEntitiesIds": [
                "5945281f-08fc-45d0-875f-638982fae1cb"
            ]
        }
    ],
    "riskAssessments": [
        {
            "anonymized": true,
            "id": "7d2bfd52-77c4-40c7-8dd2-d39a665117b7",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "b3a04793-b3a3-4678-b1e3-98b3d4f4494c",
            "date": "2022-04-13",
            "methodology": null,
            "risk": null,
            "score": 10.12,
            "assessedEntitiesIds": [
                "5c670b28-d72a-4b11-a5ec-774e102fc11b"
            ]
        }
    ],
    "therapyLines": [
        {
            "anonymized": true,
            "id": "c2b33459-cfd9-4a16-84fa-44771cf8d51b",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "6ab2d33f-d205-48d1-85b9-e48cb6a3b16a",
            "ordinal": 0,
            "intent": "curative",
            "progressionDate": "2022-04-13",
            "period": null,
            "label": "string",
            "progressionFreeSurvival": 10.12
        }
    ],
    "systemicTherapies": [
        {
            "anonymized": true,
            "id": "2806e439-f255-4756-b9ea-2938fd3b3d7f",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "0eacec06-b24a-4be8-87f8-c3f528aad3b4",
            "period": {
                "start": "2022-04-13",
                "end": "2022-04-13"
            },
            "cycles": 0,
            "intent": "curative",
            "adjunctiveRole": null,
            "terminationReason": null,
            "therapyLineId": "4880c401-e2ec-4ef2-9c71-e4d23e9f0051",
            "targetedEntitiesIds": [
                "9187ec82-7ee5-4e58-bb42-2563d84cbf01"
            ],
            "medications": [
                {
                    "id": "cbcae326-0273-4939-abcf-343b810252f8",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "drug": null,
                    "route": null,
                    "usedOfflabel": true,
                    "withinSoc": true,
                    "dosageMassConcentration": null,
                    "dosageMass": null,
                    "dosageVolume": null,
                    "dosageMassSurface": null,
                    "dosageRateMassConcentration": null,
                    "dosageRateMass": null,
                    "dosageRateVolume": null,
                    "dosageRateMassSurface": null
                }
            ],
            "isAdjunctive": true,
            "duration": {
                "value": 10.12,
                "unit": "string"
            }
        }
    ],
    "surgeries": [
        {
            "anonymized": true,
            "id": "c779bf3d-9d91-4af4-87f5-5b1e5e0b5963",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "bc3eb03d-588b-4922-931f-e75c33bd9da4",
            "date": "2022-04-13",
            "procedure": null,
            "intent": "curative",
            "bodysite": null,
            "bodysiteQualifier": null,
            "bodysiteLaterality": null,
            "outcome": null,
            "therapyLineId": "3fed3b20-fcd8-4142-8208-cce5408818cb",
            "targetedEntitiesIds": [
                "11ef4cd2-af71-4e5d-981f-783707b9a943"
            ]
        }
    ],
    "radiotherapies": [
        {
            "anonymized": true,
            "id": "0182b581-5954-4d06-a3dc-8346cb514263",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "4e183dad-633d-4036-b3b2-943508da51c8",
            "period": null,
            "sessions": 0,
            "intent": "curative",
            "terminationReason": null,
            "therapyLineId": "612a780b-17ac-4643-ae08-c97ce8e24cef",
            "targetedEntitiesIds": [
                "cbbabc28-1a39-4734-925d-704ad079a33b"
            ],
            "duration": null,
            "dosages": [
                {
                    "id": "d6bea87a-db8f-46a7-95ec-3c4d62d281aa",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "fractions": 0,
                    "dose": null,
                    "irradiatedVolume": null,
                    "irradiatedVolumeMorphology": null,
                    "irradiatedVolumeQualifier": null
                }
            ],
            "settings": [
                {
                    "id": "e191c188-b4f4-4c7c-ad9e-ce51cc7d8906",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "modality": null,
                    "technique": null
                }
            ]
        }
    ],
    "adverseEvents": [
        {
            "anonymized": true,
            "id": "7365606b-a74e-4189-a3f4-fb8419b2a930",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "38f0023f-2b30-4824-8dbf-d48d3d37b604",
            "date": "2022-04-13",
            "event": null,
            "grade": 0,
            "outcome": "resolved",
            "dateResolved": "2022-04-13",
            "suspectedCauses": [
                {
                    "id": "1924cb3f-4916-406c-b6f9-16092437c9ee",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "systemicTherapyId": "2455a901-484d-48bd-b666-7eb8d124cc92",
                    "medicationId": "7dd1285a-4b7d-4741-9431-f1b13b917a97",
                    "radiotherapyId": "5a447233-27cb-4e22-8002-1539d2c31a0e",
                    "surgeryId": "ff4fae49-a12e-46da-ac23-de59606cec60",
                    "causality": null
                }
            ],
            "mitigations": [
                {
                    "id": "78d90c89-ecf8-4d70-a212-35869a5372f4",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "category": "adjustment",
                    "adjustment": null,
                    "drug": null,
                    "procedure": null,
                    "management": null
                }
            ]
        }
    ],
    "treatmentResponses": [
        {
            "anonymized": true,
            "id": "ba9d8495-afea-4f60-9f60-b8d25e2c9fc1",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "6e9824ef-07ca-4404-85e2-4c25530cff1b",
            "date": "2022-04-13",
            "recist": null,
            "recistInterpreted": true,
            "methodology": null,
            "assessedEntitiesIds": [
                "292ca37f-f98d-4ceb-b991-a3e687574a38"
            ],
            "assessedBodysites": null
        }
    ],
    "performanceStatus": [
        {
            "anonymized": true,
            "id": "1d107c73-0be0-4ee4-aa5e-6816d06d4040",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "435724d3-1b07-4b1a-9653-0b86efb7dffc",
            "date": "2022-04-13",
            "ecogScore": 0,
            "karnofskyScore": 0,
            "ecogInterpretation": null,
            "karnofskyInterpretation": null
        }
    ],
    "comorbidities": [
        {
            "anonymized": true,
            "id": "a24f7d56-6c52-4288-b715-5fdb104161a8",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "71655255-9f92-442d-bb1d-a897c9b8d1d5",
            "date": "2022-04-13",
            "indexConditionId": "3740ef7d-bc47-4ec4-8862-d5e255214ac4",
            "panel": null,
            "presentConditions": null,
            "absentConditions": null,
            "score": null
        }
    ],
    "genomicVariants": [
        {
            "anonymized": true,
            "id": "2c1f5b31-04d7-49e1-a8d1-92e2930feabe",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "4a5bef36-4060-45ea-b879-0b38e02c2452",
            "date": "2022-04-13",
            "genes": null,
            "dnaHgvs": "string",
            "rnaHgvs": "string",
            "proteinHgvs": "string",
            "assessmentDate": "2022-04-13",
            "genePanel": "string",
            "assessment": null,
            "confidence": null,
            "analysisMethod": null,
            "clinicalRelevance": null,
            "genomeAssemblyVersion": null,
            "molecularConsequence": null,
            "copyNumber": 0,
            "alleleFrequency": 10.12,
            "alleleDepth": 0,
            "zygosity": null,
            "inheritance": null,
            "coordinateSystem": null,
            "clinvar": "string",
            "isPathogenic": true,
            "isVUS": true,
            "dnaReferenceSequence": "string",
            "dnaChangePosition": 0,
            "dnaChangePositionRange": null,
            "dnaChangeType": null,
            "rnaReferenceSequence": "string",
            "rnaChangePosition": "string",
            "rnaChangeType": null,
            "proteinReferenceSequence": "string",
            "proteinChangeType": null,
            "nucleotidesLength": 0,
            "regions": [
                "string"
            ]
        }
    ],
    "genomicSignatures": [
        null
    ],
    "vitals": [
        {
            "anonymized": true,
            "id": "f2c891e6-36c6-425c-84ff-6d24d36848f4",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "fda71617-e958-4a43-8ef2-8e48ad5f6380",
            "date": "2022-04-13",
            "height": null,
            "weight": null,
            "bloodPressureSystolic": null,
            "bloodPressureDiastolic": null,
            "temperature": null,
            "bodyMassIndex": null
        }
    ],
    "lifestyles": [
        {
            "anonymized": true,
            "id": "35a8db8f-bc69-4829-899b-5cf85e87d102",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "10a51988-5af6-4e42-a43f-dbfdc1636048",
            "date": "2022-04-13",
            "smokingStatus": null,
            "smokingPackyears": 10.12,
            "smokingQuited": null,
            "alcoholConsumption": null,
            "nightSleep": null,
            "recreationalDrugs": null,
            "exposures": null
        }
    ],
    "familyHistory": [
        {
            "anonymized": true,
            "id": "9c45fe52-705f-49cb-b8ec-d3933a03a146",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "1f7c4d8c-26c6-4717-b64a-66e1ef737ea5",
            "date": "2022-04-13",
            "relationship": null,
            "hadCancer": true,
            "contributedToDeath": true,
            "onsetAge": 0,
            "topography": null,
            "morphology": null
        }
    ],
    "tumorBoards": [
        null
    ],
    "completedDataCategories": {},
    "history": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ],
    "contributorsDetails": [
        {
            "anonymized": true,
            "id": "c9bdec19-9b0a-4a7b-a9c0-44d842c5483d",
            "externalSource": "string",
            "externalSourceId": "string",
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "organization": "string",
            "email": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "PatientCaseBundle aggregates all relevant patient case data for interoperability and import/export operations.\n\nThis schema extends PatientCase and organizes multiple related entities, such as neoplastic entities, stagings, tumor markers, risk assessments, therapies, surgeries, adverse events, treatment responses, performance status, comorbidities, genomic variants, genomic signatures, vitals, lifestyles, family history, tumor boards, completed data categories, and history events.\n\nThe order of properties is significant for import tools that rely on reference trees.\n\nAttributes:\n    neoplasticEntities (List[NeoplasticEntity]): List of neoplastic entities associated with the patient case.\n    stagings (List[Union[...]]): List of staging schemas (e.g., TNM, FIGO, Binet, etc.).\n    tumorMarkers (List[TumorMarkerSchema]): List of tumor marker schemas.\n    riskAssessments (List[RiskAssessment]): List of risk assessment schemas.\n    therapyLines (List[TherapyLine]): List of therapy line schemas.\n    systemicTherapies (List[SystemicTherapy]): List of systemic therapy schemas.\n    surgeries (List[Surgery]): List of surgery schemas.\n    radiotherapies (List[Radiotherapy]): List of radiotherapy schemas.\n    adverseEvents (List[AdverseEvent]): List of adverse event schemas.\n    treatmentResponses (List[TreatmentResponse]): List of treatment response schemas.\n    performanceStatus (List[PerformanceStatus]): List of performance status schemas.\n    comorbidities (List[ComorbiditiesAssessment]): List of comorbidities assessment schemas.\n    genomicVariants (List[GenomicVariant]): List of genomic variant schemas.\n    genomicSignatures (List[Union[...]]): List of genomic signature schemas (e.g., TMB, MSI, LOH, etc.).\n    vitals (List[Vitals]): List of vitals schemas.\n    lifestyles (List[Lifestyle]): List of lifestyle schemas.\n    familyHistory (List[FamilyHistory]): List of family history schemas.\n    tumorBoards (List[Union[UnspecifiedTumorBoard, MolecularTumorBoard]]): List of tumor board schemas.\n    completedDataCategories (Dict[PatientCaseDataCategories, PatientCaseDataCompletionStatus]): Mapping of data categories to their completion status.\n    history (List[HistoryEvent]): List of history events related to the patient case.\n\nMethods:\n    resolve_stagings(obj): Resolves and serializes staging data for the patient case.\n    resolve_genomicSignatures(obj): Resolves and serializes genomic signature data.\n    resolve_tumorBoards(obj): Resolves and serializes tumor board data.\n    resolve_completedDataCategories(obj): Resolves completion status for each data category.\n    resolve_history(obj): Resolves and retrieves history events for the patient case.\n\nConfig:\n    model_config: Serialization configuration (serialize_by_alias=False).",
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "clinicalCenter": {
            "description": "Medical center where the patient data originally resides",
            "maxLength": 200,
            "title": "Medical center",
            "type": "string"
        },
        "clinicalIdentifier": {
            "description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
            "maxLength": 100,
            "title": "Clinical identifier",
            "type": "string"
        },
        "consentStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Status of the general consent by the patient for the use of their data for research purposes",
            "title": "Consent status"
        },
        "gender": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Gender of the patient for legal/administrative purposes",
            "title": "Gender",
            "x-terminology": "AdministrativeGender"
        },
        "race": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Race of the patient",
            "title": "Race",
            "x-terminology": "Race"
        },
        "sexAtBirth": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Sex assigned at birth",
            "title": "Birth sex",
            "x-terminology": "BirthSex"
        },
        "genderIdentity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The patient's innate sense of their gender as reported",
            "title": "Gender identity",
            "x-terminology": "GenderIdentity"
        },
        "dateOfBirth": {
            "anyOf": [
                {
                    "format": "date",
                    "type": "string"
                },
                {
                    "const": "*************",
                    "type": "string"
                }
            ],
            "description": "Date of birth of the patient",
            "title": "Date of birth"
        },
        "vitalStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Whether the patient is known to be alive or decaeased or is unknkown.",
            "title": "Vital status"
        },
        "dateOfDeath": {
            "description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of death",
            "type": "string"
        },
        "causeOfDeath": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the cause of death.",
            "title": "Cause of death",
            "x-terminology": "CauseOfDeath"
        },
        "endOfRecords": {
            "description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
            "format": "date",
            "title": "End of records",
            "type": "string"
        },
        "pseudoidentifier": {
            "description": "Pseudoidentifier of the patient",
            "maxLength": 40,
            "title": "Pseudoidentifier",
            "type": "string"
        },
        "age": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years",
            "title": "Age"
        },
        "overallSurvival": {
            "description": "Overall survival of the patient since diagnosis",
            "title": "Overall survival",
            "type": "number"
        },
        "ageAtDiagnosis": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years at the time of the initial diagnosis",
            "title": "Age at diagnosis"
        },
        "dataCompletionRate": {
            "description": "Percentage indicating the completeness of a case in terms of its data.",
            "title": "Data completion rate",
            "type": "number"
        },
        "contributors": {
            "description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
            "items": {
                "type": "string"
            },
            "title": "Data contributors",
            "type": "array"
        },
        "neoplasticEntities": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/NeoplasticEntity"
            },
            "title": "Neoplasticentities",
            "type": "array"
        },
        "stagings": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/TNMStaging"
                    },
                    {
                        "$ref": "#/components/schemas/FIGOStaging"
                    },
                    {
                        "$ref": "#/components/schemas/BinetStaging"
                    },
                    {
                        "$ref": "#/components/schemas/RaiStaging"
                    },
                    {
                        "$ref": "#/components/schemas/BreslowDepth"
                    },
                    {
                        "$ref": "#/components/schemas/ClarkStaging"
                    },
                    {
                        "$ref": "#/components/schemas/ISSStaging"
                    },
                    {
                        "$ref": "#/components/schemas/RISSStaging"
                    },
                    {
                        "$ref": "#/components/schemas/GleasonGrade"
                    },
                    {
                        "$ref": "#/components/schemas/INSSStage"
                    },
                    {
                        "$ref": "#/components/schemas/INRGSSStage"
                    },
                    {
                        "$ref": "#/components/schemas/WilmsStage"
                    },
                    {
                        "$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
                    },
                    {
                        "$ref": "#/components/schemas/LymphomaStaging"
                    }
                ]
            },
            "title": "Stagings",
            "type": "array"
        },
        "tumorMarkers": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TumorMarker"
            },
            "title": "Tumormarkers",
            "type": "array"
        },
        "riskAssessments": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/RiskAssessment"
            },
            "title": "Riskassessments",
            "type": "array"
        },
        "therapyLines": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TherapyLine"
            },
            "title": "Therapylines",
            "type": "array"
        },
        "systemicTherapies": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/SystemicTherapy"
            },
            "title": "Systemictherapies",
            "type": "array"
        },
        "surgeries": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Surgery"
            },
            "title": "Surgeries",
            "type": "array"
        },
        "radiotherapies": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Radiotherapy"
            },
            "title": "Radiotherapies",
            "type": "array"
        },
        "adverseEvents": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/AdverseEvent"
            },
            "title": "Adverseevents",
            "type": "array"
        },
        "treatmentResponses": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/TreatmentResponse"
            },
            "title": "Treatmentresponses",
            "type": "array"
        },
        "performanceStatus": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/PerformanceStatus"
            },
            "title": "Performancestatus",
            "type": "array"
        },
        "comorbidities": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/ComorbiditiesAssessment"
            },
            "title": "Comorbidities",
            "type": "array"
        },
        "genomicVariants": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/GenomicVariant"
            },
            "title": "Genomicvariants",
            "type": "array"
        },
        "genomicSignatures": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/TumorMutationalBurden"
                    },
                    {
                        "$ref": "#/components/schemas/MicrosatelliteInstability"
                    },
                    {
                        "$ref": "#/components/schemas/LossOfHeterozygosity"
                    },
                    {
                        "$ref": "#/components/schemas/HomologousRecombinationDeficiency"
                    },
                    {
                        "$ref": "#/components/schemas/TumorNeoantigenBurden"
                    },
                    {
                        "$ref": "#/components/schemas/AneuploidScore"
                    }
                ]
            },
            "title": "Genomicsignatures",
            "type": "array"
        },
        "vitals": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Vitals"
            },
            "title": "Vitals",
            "type": "array"
        },
        "lifestyles": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/Lifestyle"
            },
            "title": "Lifestyles",
            "type": "array"
        },
        "familyHistory": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/FamilyHistory"
            },
            "title": "Familyhistory",
            "type": "array"
        },
        "tumorBoards": {
            "default": [],
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/UnspecifiedTumorBoard"
                    },
                    {
                        "$ref": "#/components/schemas/MolecularTumorBoard"
                    }
                ]
            },
            "title": "Tumorboards",
            "type": "array"
        },
        "completedDataCategories": {
            "additionalProperties": {
                "$ref": "#/components/schemas/PatientCaseDataCompletionStatus"
            },
            "propertyNames": {
                "$ref": "#/components/schemas/PatientCaseDataCategoryChoices"
            },
            "title": "Completeddatacategories",
            "type": "object"
        },
        "history": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "History",
            "type": "array"
        },
        "contributorsDetails": {
            "default": [],
            "items": {
                "$ref": "#/components/schemas/UserExport"
            },
            "title": "Contributorsdetails",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "clinicalCenter",
        "clinicalIdentifier",
        "gender",
        "dateOfBirth",
        "pseudoidentifier",
        "age",
        "dataCompletionRate",
        "contributors",
        "completedDataCategories"
    ],
    "title": "PatientCaseBundle",
    "type": "object"
}

Response 201 Created

{
    "id": "a085d170-6909-4e5c-9274-2ca5f1785337",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Patient Cases


GET /api/v1/patient-cases

Get All Patient Cases Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
age.between query array No Age - Filter for entries with values between two specified values (inclusive)
age.equal query integer No Age - Filter for entries with values exactly equal to the specified value
age.greaterThan query integer No Age - Filter for entries with values greater than the specified value
age.greaterThanOrEqual query integer No Age - Filter for entries with values greater than or equal to the specified value
age.lessThan query integer No Age - Filter for entries with values less than the specified value
age.lessThanOrEqual query integer No Age - Filter for entries with values less than or equal to the specified value
age.not.between query array No Age - Filter for entries with values between two specified values (inclusive)
age.not.equal query integer No Age - Filter for entries with values not equal to the specified value
ageAtDiagnosis.between query array No Age at diagnosis - Filter for entries with values between two specified values (inclusive)
ageAtDiagnosis.equal query integer No Age at diagnosis - Filter for entries with values exactly equal to the specified value
ageAtDiagnosis.exists query boolean No Age at diagnosis - Filter for entries with a value
ageAtDiagnosis.greaterThan query integer No Age at diagnosis - Filter for entries with values greater than the specified value
ageAtDiagnosis.greaterThanOrEqual query integer No Age at diagnosis - Filter for entries with values greater than or equal to the specified value
ageAtDiagnosis.lessThan query integer No Age at diagnosis - Filter for entries with values less than the specified value
ageAtDiagnosis.lessThanOrEqual query integer No Age at diagnosis - Filter for entries with values less than or equal to the specified value
ageAtDiagnosis.not.between query array No Age at diagnosis - Filter for entries with values between two specified values (inclusive)
ageAtDiagnosis.not.equal query integer No Age at diagnosis - Filter for entries with values not equal to the specified value
ageAtDiagnosis.not.exists query boolean No Age at diagnosis - Filter for entries without a value
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
causeOfDeath query string No Cause of death - Filter for a matching concept code
causeOfDeath.anyOf query array No Cause of death - Filter for a matching set of concept codes
causeOfDeath.descendantsOf query string No Cause of death - Filter for all child concepts of a given concepts code
causeOfDeath.exists query boolean No Cause of death - Filter for entries with a value
causeOfDeath.not query string No Cause of death - Filter for a mismatching concept code
causeOfDeath.not.anyOf query array No Cause of death - Filter for a mismmatching set of concept codes
causeOfDeath.not.exists query boolean No Cause of death - Filter for entries without a value
consentStatus query None No Consent status - Filter for single value choice
consentStatus.anyOf query array No Consent status - ('Filter for excluding a subset of value choices',)
consentStatus.not query None No Consent status - ('Filter for all but a single value choice',)
contributors query array No Data contributors - Filter for exact array matches
contributors.containedBy query array No Data contributors - Filter for entries where where the data is a subset of the values passed
contributors.contains query array No Data contributors - Filter for entries where where the values passed are a subset of the data
contributors.not query array No Data contributors - Filter for exact array mismatches
contributors.not.containedBy query array No Data contributors - Filter for entries where the data is not a subset of the values passed
contributors.not.contains query array No Data contributors - Filter for entries where the values passed are not a subset of the data
contributors.not.overlaps query array No Data contributors - Filter for entries where the data shares not any results with the values passed.
contributors.overlaps query array No Data contributors - Filter for entries where the data shares any results with the values passed.
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
dataCompletionRate.between query array No Data completion rate - Filter for entries with values between two specified values (inclusive)
dataCompletionRate.equal query number No Data completion rate - Filter for entries with values exactly equal to the specified value
dataCompletionRate.greaterThan query number No Data completion rate - Filter for entries with values greater than the specified value
dataCompletionRate.greaterThanOrEqual query number No Data completion rate - Filter for entries with values greater than or equal to the specified value
dataCompletionRate.lessThan query number No Data completion rate - Filter for entries with values less than the specified value
dataCompletionRate.lessThanOrEqual query number No Data completion rate - Filter for entries with values less than or equal to the specified value
dataCompletionRate.not.between query array No Data completion rate - Filter for entries with values between two specified values (inclusive)
dataCompletionRate.not.equal query number No Data completion rate - Filter for entries with values not equal to the specified value
endOfRecords.after query string No End of records - Filter for entries with dates after the specified value
endOfRecords.before query string No End of records - Filter for entries with dates before the specified value
endOfRecords.between query array No End of records - Filter for entries with dates between two specified values (inclusive)
endOfRecords.exists query boolean No End of records - Filter for entries with a value
endOfRecords.not.between query array No End of records - Filter for entries with dates not between two specified values (inclusive)
endOfRecords.not.exists query boolean No End of records - Filter for entries without a value
endOfRecords.not.on query string No End of records - Filter for entries with dates not matching the specified value
endOfRecords.on query string No End of records - Filter for entries with dates exactly matching the specified value
endOfRecords.onOrAfter query string No End of records - Filter for entries with dates on or after the specified value
endOfRecords.onOrBefore query string No End of records - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
gender query string No Gender - Filter for a matching concept code
gender.anyOf query array No Gender - Filter for a matching set of concept codes
gender.descendantsOf query string No Gender - Filter for all child concepts of a given concepts code
gender.not query string No Gender - Filter for a mismatching concept code
gender.not.anyOf query array No Gender - Filter for a mismmatching set of concept codes
genderIdentity query string No Gender identity - Filter for a matching concept code
genderIdentity.anyOf query array No Gender identity - Filter for a matching set of concept codes
genderIdentity.descendantsOf query string No Gender identity - Filter for all child concepts of a given concepts code
genderIdentity.exists query boolean No Gender identity - Filter for entries with a value
genderIdentity.not query string No Gender identity - Filter for a mismatching concept code
genderIdentity.not.anyOf query array No Gender identity - Filter for a mismmatching set of concept codes
genderIdentity.not.exists query boolean No Gender identity - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
idSearch query string No
limit query integer 10 No
morphology query string No Morphology - Filters for matching primary morphology code.
offset query integer 0 No
ordering query None No
overallSurvival.between query array No Overall survival - Filter for entries with values between two specified values (inclusive)
overallSurvival.equal query number No Overall survival - Filter for entries with values exactly equal to the specified value
overallSurvival.exists query boolean No Overall survival - Filter for entries with a value
overallSurvival.greaterThan query number No Overall survival - Filter for entries with values greater than the specified value
overallSurvival.greaterThanOrEqual query number No Overall survival - Filter for entries with values greater than or equal to the specified value
overallSurvival.lessThan query number No Overall survival - Filter for entries with values less than the specified value
overallSurvival.lessThanOrEqual query number No Overall survival - Filter for entries with values less than or equal to the specified value
overallSurvival.not.between query array No Overall survival - Filter for entries with values between two specified values (inclusive)
overallSurvival.not.equal query number No Overall survival - Filter for entries with values not equal to the specified value
overallSurvival.not.exists query boolean No Overall survival - Filter for entries without a value
primarySite query string No Primary site - Filters for matching primary topography code.
pseudoidentifier query string No Pseudoidentifier - Filter for full text matches
pseudoidentifier.anyOf query array No Pseudoidentifier - Filter for entries where at least one reference matches the query
pseudoidentifier.beginsWith query string No Pseudoidentifier - Filter for entries starting with the text
pseudoidentifier.contains query string No Pseudoidentifier - Filter for partial text matches
pseudoidentifier.endsWith query string No Pseudoidentifier - Filter for entries ending with the text
pseudoidentifier.not query string No Pseudoidentifier - Filter for full text mismatches
pseudoidentifier.not.anyOf query array No Pseudoidentifier - Filter for entries where at least one reference mismatches the query
pseudoidentifier.not.beginsWith query string No Pseudoidentifier - Filter for entries not starting with the text
pseudoidentifier.not.contains query string No Pseudoidentifier - Filter for partial text mismatches
pseudoidentifier.not.endsWith query string No Pseudoidentifier - Filter for entries not ending with the text
race query string No Race - Filter for a matching concept code
race.anyOf query array No Race - Filter for a matching set of concept codes
race.descendantsOf query string No Race - Filter for all child concepts of a given concepts code
race.exists query boolean No Race - Filter for entries with a value
race.not query string No Race - Filter for a mismatching concept code
race.not.anyOf query array No Race - Filter for a mismmatching set of concept codes
race.not.exists query boolean No Race - Filter for entries without a value
sexAtBirth query string No Birth sex - Filter for a matching concept code
sexAtBirth.anyOf query array No Birth sex - Filter for a matching set of concept codes
sexAtBirth.descendantsOf query string No Birth sex - Filter for all child concepts of a given concepts code
sexAtBirth.exists query boolean No Birth sex - Filter for entries with a value
sexAtBirth.not query string No Birth sex - Filter for a mismatching concept code
sexAtBirth.not.anyOf query array No Birth sex - Filter for a mismmatching set of concept codes
sexAtBirth.not.exists query boolean No Birth sex - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
vitalStatus query None No Vital status - Filter for single value choice
vitalStatus.anyOf query array No Vital status - ('Filter for excluding a subset of value choices',)
vitalStatus.not query None No Vital status - ('Filter for all but a single value choice',)

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "1b031d09-42cd-4294-a45c-0d7715f9c5ee",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "clinicalCenter": "string",
            "clinicalIdentifier": "string",
            "consentStatus": null,
            "gender": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "race": null,
            "sexAtBirth": null,
            "genderIdentity": null,
            "dateOfBirth": null,
            "vitalStatus": null,
            "dateOfDeath": "2022-04-13",
            "causeOfDeath": null,
            "endOfRecords": "2022-04-13",
            "pseudoidentifier": "string",
            "age": null,
            "overallSurvival": 10.12,
            "ageAtDiagnosis": null,
            "dataCompletionRate": 10.12,
            "contributors": [
                "string"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/PatientCase"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[PatientCase]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/patient-cases

Create Patient Case

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "clinicalCenter": "string",
    "clinicalIdentifier": "string",
    "consentStatus": null,
    "gender": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "race": null,
    "sexAtBirth": null,
    "genderIdentity": null,
    "dateOfBirth": "2022-04-13",
    "vitalStatus": null,
    "dateOfDeath": "2022-04-13",
    "causeOfDeath": null,
    "endOfRecords": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "clinicalCenter": {
            "description": "Medical center where the patient data originally resides",
            "maxLength": 200,
            "title": "Medical center",
            "type": "string"
        },
        "clinicalIdentifier": {
            "description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
            "maxLength": 100,
            "title": "Clinical identifier",
            "type": "string"
        },
        "consentStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Status of the general consent by the patient for the use of their data for research purposes",
            "title": "Consent status"
        },
        "gender": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Gender of the patient for legal/administrative purposes",
            "title": "Gender",
            "x-terminology": "AdministrativeGender"
        },
        "race": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Race of the patient",
            "title": "Race",
            "x-terminology": "Race"
        },
        "sexAtBirth": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Sex assigned at birth",
            "title": "Birth sex",
            "x-terminology": "BirthSex"
        },
        "genderIdentity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The patient's innate sense of their gender as reported",
            "title": "Gender identity",
            "x-terminology": "GenderIdentity"
        },
        "dateOfBirth": {
            "description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of birth",
            "type": "string"
        },
        "vitalStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Whether the patient is known to be alive or decaeased or is unknkown.",
            "title": "Vital status"
        },
        "dateOfDeath": {
            "description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of death",
            "type": "string"
        },
        "causeOfDeath": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the cause of death.",
            "title": "Cause of death",
            "x-terminology": "CauseOfDeath"
        },
        "endOfRecords": {
            "description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
            "format": "date",
            "title": "End of records",
            "type": "string"
        }
    },
    "required": [
        "clinicalCenter",
        "clinicalIdentifier",
        "gender",
        "dateOfBirth"
    ],
    "title": "PatientCaseCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "a77c5b24-35e9-4320-9f09-feda88577275",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/patient-cases/{caseId}

Get Patient Case By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId path string No
clinicalCenter query None No
type query None id No

Response 200 OK

{
    "anonymized": true,
    "id": "24fd138c-3cb8-4a56-b4a0-1fbe816b8a10",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "clinicalCenter": "string",
    "clinicalIdentifier": "string",
    "consentStatus": null,
    "gender": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "race": null,
    "sexAtBirth": null,
    "genderIdentity": null,
    "dateOfBirth": null,
    "vitalStatus": null,
    "dateOfDeath": "2022-04-13",
    "causeOfDeath": null,
    "endOfRecords": "2022-04-13",
    "pseudoidentifier": "string",
    "age": null,
    "overallSurvival": 10.12,
    "ageAtDiagnosis": null,
    "dataCompletionRate": 10.12,
    "contributors": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "clinicalCenter": {
            "description": "Medical center where the patient data originally resides",
            "maxLength": 200,
            "title": "Medical center",
            "type": "string"
        },
        "clinicalIdentifier": {
            "description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
            "maxLength": 100,
            "title": "Clinical identifier",
            "type": "string"
        },
        "consentStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Status of the general consent by the patient for the use of their data for research purposes",
            "title": "Consent status"
        },
        "gender": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Gender of the patient for legal/administrative purposes",
            "title": "Gender",
            "x-terminology": "AdministrativeGender"
        },
        "race": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Race of the patient",
            "title": "Race",
            "x-terminology": "Race"
        },
        "sexAtBirth": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Sex assigned at birth",
            "title": "Birth sex",
            "x-terminology": "BirthSex"
        },
        "genderIdentity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The patient's innate sense of their gender as reported",
            "title": "Gender identity",
            "x-terminology": "GenderIdentity"
        },
        "dateOfBirth": {
            "anyOf": [
                {
                    "format": "date",
                    "type": "string"
                },
                {
                    "const": "*************",
                    "type": "string"
                }
            ],
            "description": "Date of birth of the patient",
            "title": "Date of birth"
        },
        "vitalStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Whether the patient is known to be alive or decaeased or is unknkown.",
            "title": "Vital status"
        },
        "dateOfDeath": {
            "description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of death",
            "type": "string"
        },
        "causeOfDeath": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the cause of death.",
            "title": "Cause of death",
            "x-terminology": "CauseOfDeath"
        },
        "endOfRecords": {
            "description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
            "format": "date",
            "title": "End of records",
            "type": "string"
        },
        "pseudoidentifier": {
            "description": "Pseudoidentifier of the patient",
            "maxLength": 40,
            "title": "Pseudoidentifier",
            "type": "string"
        },
        "age": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years",
            "title": "Age"
        },
        "overallSurvival": {
            "description": "Overall survival of the patient since diagnosis",
            "title": "Overall survival",
            "type": "number"
        },
        "ageAtDiagnosis": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "$ref": "#/components/schemas/AgeBin"
                }
            ],
            "description": "Approximate age of the patient in years at the time of the initial diagnosis",
            "title": "Age at diagnosis"
        },
        "dataCompletionRate": {
            "description": "Percentage indicating the completeness of a case in terms of its data.",
            "title": "Data completion rate",
            "type": "number"
        },
        "contributors": {
            "description": "Users that have contributed to the case by adding, updating or deleting data. Sorted by number of contributions in descending order.",
            "items": {
                "type": "string"
            },
            "title": "Data contributors",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "clinicalCenter",
        "clinicalIdentifier",
        "gender",
        "dateOfBirth",
        "pseudoidentifier",
        "age",
        "dataCompletionRate",
        "contributors"
    ],
    "title": "PatientCase",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/patient-cases/{caseId}

Update Patient Case

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "clinicalCenter": "string",
    "clinicalIdentifier": "string",
    "consentStatus": null,
    "gender": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "race": null,
    "sexAtBirth": null,
    "genderIdentity": null,
    "dateOfBirth": "2022-04-13",
    "vitalStatus": null,
    "dateOfDeath": "2022-04-13",
    "causeOfDeath": null,
    "endOfRecords": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "clinicalCenter": {
            "description": "Medical center where the patient data originally resides",
            "maxLength": 200,
            "title": "Medical center",
            "type": "string"
        },
        "clinicalIdentifier": {
            "description": "Unique clinical identifier (typically the clinical information system identifier) unique for a physical patient",
            "maxLength": 100,
            "title": "Clinical identifier",
            "type": "string"
        },
        "consentStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseConsentStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Status of the general consent by the patient for the use of their data for research purposes",
            "title": "Consent status"
        },
        "gender": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Gender of the patient for legal/administrative purposes",
            "title": "Gender",
            "x-terminology": "AdministrativeGender"
        },
        "race": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Race of the patient",
            "title": "Race",
            "x-terminology": "Race"
        },
        "sexAtBirth": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Sex assigned at birth",
            "title": "Birth sex",
            "x-terminology": "BirthSex"
        },
        "genderIdentity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The patient's innate sense of their gender as reported",
            "title": "Gender identity",
            "x-terminology": "GenderIdentity"
        },
        "dateOfBirth": {
            "description": "Anonymized date of birth (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of birth",
            "type": "string"
        },
        "vitalStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PatientCaseVitalStatusChoices"
                }
            ],
            "default": "unknown",
            "description": "Whether the patient is known to be alive or decaeased or is unknkown.",
            "title": "Vital status"
        },
        "dateOfDeath": {
            "description": "Anonymized date of death (year/month). The day is set to the first day of the month by convention.",
            "format": "date",
            "title": "Date of death",
            "type": "string"
        },
        "causeOfDeath": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the cause of death.",
            "title": "Cause of death",
            "x-terminology": "CauseOfDeath"
        },
        "endOfRecords": {
            "description": "Date of the last known record about the patient if lost to followup or vital status is unknown.",
            "format": "date",
            "title": "End of records",
            "type": "string"
        }
    },
    "required": [
        "clinicalCenter",
        "clinicalIdentifier",
        "gender",
        "dateOfBirth"
    ],
    "title": "PatientCaseCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "773dfc45-5fdc-4538-8945-bf1c969379fc",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/patient-cases/{caseId}

Delete Patient Case

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/patient-cases/{caseId}/history/events

Get All Patient Case History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/patient-cases/{caseId}/history/events/{eventId}

Get Patient Case History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/patient-cases/{caseId}/history/events/{eventId}/reversion

Revert Patient Case To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
eventId path string No

Response 201 Created

{
    "id": "cfcbfa64-5aa3-49c2-9c30-fb029dd7ec2d",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/patient-cases/{caseId}/data-completion/{category}

Get Patient Case Data Completion Status

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
category path string No Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses.

Response 200 OK

{
    "status": true,
    "username": "string",
    "timestamp": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "status": {
            "description": "Boolean indicating whether the data category has been marked as completed",
            "title": "Status",
            "type": "boolean"
        },
        "username": {
            "description": "Username of the person who marked the category as completed",
            "title": "Username",
            "type": "string"
        },
        "timestamp": {
            "description": "Username of the person who marked the category as completed",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        }
    },
    "required": [
        "status"
    ],
    "title": "PatientCaseDataCompletionStatus",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/patient-cases/{caseId}/data-completion/{category}

Create Patient Case Data Completion

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
category path string No Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses.

Response 201 Created

{
    "id": "613e7c1d-fe20-495c-a17f-59d2fc928b47",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/patient-cases/{caseId}/data-completion/{category}

Delete Patient Case Data Completion

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No
category path string No Enumeration of data categories associated with a patient case in oncology. Attributes: COMORBIDITIES_ASSESSMENTS: Category for comorbidities assessments. FAMILY_HISTORIES: Category for family medical histories. GENOMIC_SIGNATURES: Category for genomic signatures. GENOMIC_VARIANTS: Category for genomic variants. LIFESTYLES: Category for patient lifestyles. COMORBIDITIES: Category for comorbidities. NEOPLASTIC_ENTITIES: Category for neoplastic entities. PERFORMANCE_STATUS: Category for performance status. RADIOTHERAPIES: Category for radiotherapy treatments. RISK_ASSESSMENTS: Category for risk assessments. STAGINS: Category for cancer stagings. SURGERIES: Category for surgical procedures. SYSTEMIC_THERAPIES: Category for systemic therapies. TUMOR_MARKERS: Category for tumor marker data. VITALS: Category for vital signs. TUMOR_BOARD_REVIEWS: Category for tumor board reviews. ADVERSE_EVENTS: Category for adverse events. THERAPY_RESPONSES: Category for therapy responses.

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/autocomplete/clinical-centers

Get Clinical Centers

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
query query string No

Response 200 OK

[
    "string"
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "type": "string"
    },
    "title": "Response",
    "type": "array"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Response 501 Not Implemented

Neoplastic Entities


GET /api/v1/neoplastic-entities

Get All Neoplastic Entities Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
assertionDate.after query string No Assertion date - Filter for entries with dates after the specified value
assertionDate.before query string No Assertion date - Filter for entries with dates before the specified value
assertionDate.between query array No Assertion date - Filter for entries with dates between two specified values (inclusive)
assertionDate.not.between query array No Assertion date - Filter for entries with dates not between two specified values (inclusive)
assertionDate.not.on query string No Assertion date - Filter for entries with dates not matching the specified value
assertionDate.on query string No Assertion date - Filter for entries with dates exactly matching the specified value
assertionDate.onOrAfter query string No Assertion date - Filter for entries with dates on or after the specified value
assertionDate.onOrBefore query string No Assertion date - Filter for entries with dates on or before the specified value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
differentitation query string No Differentiation - Filter for a matching concept code
differentitation.anyOf query array No Differentiation - Filter for a matching set of concept codes
differentitation.descendantsOf query string No Differentiation - Filter for all child concepts of a given concepts code
differentitation.exists query boolean No Differentiation - Filter for entries with a value
differentitation.not query string No Differentiation - Filter for a mismatching concept code
differentitation.not.anyOf query array No Differentiation - Filter for a mismmatching set of concept codes
differentitation.not.exists query boolean No Differentiation - Filter for entries without a value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
laterality query string No Laterality - Filter for a matching concept code
laterality.anyOf query array No Laterality - Filter for a matching set of concept codes
laterality.descendantsOf query string No Laterality - Filter for all child concepts of a given concepts code
laterality.exists query boolean No Laterality - Filter for entries with a value
laterality.not query string No Laterality - Filter for a mismatching concept code
laterality.not.anyOf query array No Laterality - Filter for a mismmatching set of concept codes
laterality.not.exists query boolean No Laterality - Filter for entries without a value
limit query integer 10 No
morphology query string No Morphology - Filter for a matching concept code
morphology.anyOf query array No Morphology - Filter for a matching set of concept codes
morphology.descendantsOf query string No Morphology - Filter for all child concepts of a given concepts code
morphology.not query string No Morphology - Filter for a mismatching concept code
morphology.not.anyOf query array No Morphology - Filter for a mismmatching set of concept codes
offset query integer 0 No
ordering query None No
relatedPrimaryId query string No Related primary neoplasm - Filter for reference matches
relatedPrimaryId.anyOf query array No Related primary neoplasm - Filter for entries where at least one reference matches the query
relatedPrimaryId.beginsWith query string No Related primary neoplasm - Filter for entries starting with the text
relatedPrimaryId.contains query string No Related primary neoplasm - Filter for partial text matches
relatedPrimaryId.endsWith query string No Related primary neoplasm - Filter for entries ending with the text
relatedPrimaryId.exists query boolean No Related primary neoplasm - Filter for entries with a value
relatedPrimaryId.not query string No Related primary neoplasm - Filter for reference mismatches
relatedPrimaryId.not.anyOf query array No Related primary neoplasm - Filter for entries where at least one reference mismatches the query
relatedPrimaryId.not.beginsWith query string No Related primary neoplasm - Filter for entries not starting with the text
relatedPrimaryId.not.contains query string No Related primary neoplasm - Filter for partial text mismatches
relatedPrimaryId.not.endsWith query string No Related primary neoplasm - Filter for entries not ending with the text
relatedPrimaryId.not.exists query boolean No Related primary neoplasm - Filter for entries without a value
relationship query None No Neoplastic relationship - Filter for single value choice
relationship.anyOf query array No Neoplastic relationship - ('Filter for excluding a subset of value choices',)
relationship.not query None No Neoplastic relationship - ('Filter for all but a single value choice',)
topography query string No Topography - Filter for a matching concept code
topography.anyOf query array No Topography - Filter for a matching set of concept codes
topography.descendantsOf query string No Topography - Filter for all child concepts of a given concepts code
topography.not query string No Topography - Filter for a mismatching concept code
topography.not.anyOf query array No Topography - Filter for a mismmatching set of concept codes
topographyGroup query string No Topographical group - Filter for a matching concept code
topographyGroup.anyOf query array No Topographical group - Filter for a matching set of concept codes
topographyGroup.descendantsOf query string No Topographical group - Filter for all child concepts of a given concepts code
topographyGroup.exists query boolean No Topographical group - Filter for entries with a value
topographyGroup.not query string No Topographical group - Filter for a mismatching concept code
topographyGroup.not.anyOf query array No Topographical group - Filter for a mismmatching set of concept codes
topographyGroup.not.exists query boolean No Topographical group - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "80e816e2-b570-4731-a57a-dece76cc2e99",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "7c70001c-f2ba-488c-9e32-e0ffcbfaabab",
            "relationship": "primary",
            "relatedPrimaryId": "8806bfda-a6f5-4d17-84e6-c8ee535892d7",
            "assertionDate": "2022-04-13",
            "topography": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "morphology": null,
            "differentitation": null,
            "laterality": null,
            "topographyGroup": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/NeoplasticEntity"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[NeoplasticEntity]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/neoplastic-entities

Create Neoplastic Entity

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "69a565de-6284-42f9-942e-124a13f91acc",
    "relationship": "primary",
    "relatedPrimaryId": "fa9e0b4f-2ccb-462d-8acc-b665a5bfc0f1",
    "assertionDate": "2022-04-13",
    "topography": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "morphology": null,
    "differentitation": null,
    "laterality": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's neoplasm(s) are recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
            "description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
            "title": "Neoplastic relationship"
        },
        "relatedPrimaryId": {
            "description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
            "format": "uuid",
            "title": "Related primary neoplasm",
            "type": "string"
        },
        "assertionDate": {
            "description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
            "format": "date",
            "title": "Assertion date",
            "type": "string"
        },
        "topography": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the neoplasm(s)",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        },
        "differentitation": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphologic differentitation characteristics of the neoplasm(s)",
            "title": "Differentiation",
            "x-terminology": "HistologyDifferentiation"
        },
        "laterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality qualifier for the location of the neoplasm(s)",
            "title": "Laterality",
            "x-terminology": "LateralityQualifier"
        }
    },
    "required": [
        "caseId",
        "relationship",
        "assertionDate",
        "topography",
        "morphology"
    ],
    "title": "NeoplasticEntityCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "b73803cf-716d-4916-b277-b42c663f8711",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/neoplastic-entities/{entityId}

Get Neoplastic Entity By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
entityId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "562e8807-5d85-4b30-ad0b-f3a8245c4f6e",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "5a96a968-a097-4763-a40d-10825a132514",
    "relationship": "primary",
    "relatedPrimaryId": "3d7ec4fa-ba40-42c4-83ae-2cb34548f1ec",
    "assertionDate": "2022-04-13",
    "topography": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "morphology": null,
    "differentitation": null,
    "laterality": null,
    "topographyGroup": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's neoplasm(s) are recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
            "description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
            "title": "Neoplastic relationship"
        },
        "relatedPrimaryId": {
            "description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
            "format": "uuid",
            "title": "Related primary neoplasm",
            "type": "string"
        },
        "assertionDate": {
            "description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
            "format": "date",
            "title": "Assertion date",
            "type": "string"
        },
        "topography": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the neoplasm(s)",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        },
        "differentitation": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphologic differentitation characteristics of the neoplasm(s)",
            "title": "Differentiation",
            "x-terminology": "HistologyDifferentiation"
        },
        "laterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality qualifier for the location of the neoplasm(s)",
            "title": "Laterality",
            "x-terminology": "LateralityQualifier"
        },
        "topographyGroup": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Broad anatomical location of the neoplastic entity",
            "title": "Topographical group",
            "x-terminology": "CancerTopographyGroup"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "relationship",
        "assertionDate",
        "topography",
        "morphology"
    ],
    "title": "NeoplasticEntity",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/neoplastic-entities/{entityId}

Update Neoplastic Entity

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
entityId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "8e9d9319-63bc-4918-ba49-7a515036cfff",
    "relationship": "primary",
    "relatedPrimaryId": "d29198c7-6c5f-4abd-87e0-92a8590e7816",
    "assertionDate": "2022-04-13",
    "topography": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "morphology": null,
    "differentitation": null,
    "laterality": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's neoplasm(s) are recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/NeoplasticEntityRelationshipChoices",
            "description": "Relationship linking secondary and recurrent tumors to their primary origin or for distinguishing between different phases of the disease.",
            "title": "Neoplastic relationship"
        },
        "relatedPrimaryId": {
            "description": "Reference to the primary neoplasm of which the neoplasm(s) originated from.",
            "format": "uuid",
            "title": "Related primary neoplasm",
            "type": "string"
        },
        "assertionDate": {
            "description": "The date on which the existence of the neoplasm(s) was first asserted or acknowledged",
            "format": "date",
            "title": "Assertion date",
            "type": "string"
        },
        "topography": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the neoplasm(s)",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Describes the cell type of the tumor and its biologic activity, in other words, the characteristics of the tumor itself",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        },
        "differentitation": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphologic differentitation characteristics of the neoplasm(s)",
            "title": "Differentiation",
            "x-terminology": "HistologyDifferentiation"
        },
        "laterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality qualifier for the location of the neoplasm(s)",
            "title": "Laterality",
            "x-terminology": "LateralityQualifier"
        }
    },
    "required": [
        "caseId",
        "relationship",
        "assertionDate",
        "topography",
        "morphology"
    ],
    "title": "NeoplasticEntityCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "e6234d79-aa25-41d4-b3f5-15fb2d89644f",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/neoplastic-entities/{entityId}

Delete Neoplastic Entity

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
entityId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/neoplastic-entities/{entityId}/history/events

Get All Neoplastic Entity History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
entityId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}

Get Neoplastic Entity History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
entityId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/neoplastic-entities/{entityId}/history/events/{eventId}/reversion

Revert Neoplastic Entity To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
entityId path string No
eventId path string No

Response 201 Created

{
    "id": "f54d2fee-2884-4fda-8590-75e9e4a9814d",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Stagings


GET /api/v1/stagings

Get All Stagings Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Staging date - Filter for entries with dates after the specified value
date.before query string No Staging date - Filter for entries with dates before the specified value
date.between query array No Staging date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Staging date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Staging date - Filter for entries with dates not matching the specified value
date.on query string No Staging date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Staging date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Staging date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
stage query string No Stage - Filter for a matching concept code
stage.anyOf query array No Stage - Filter for a matching set of concept codes
stage.descendantsOf query string No Stage - Filter for all child concepts of a given concepts code
stage.not query string No Stage - Filter for a mismatching concept code
stage.not.anyOf query array No Stage - Filter for a mismmatching set of concept codes
stagedEntitiesIds query string No Staged neoplastic entities - Filter for full text matches
stagedEntitiesIds.anyOf query array No Staged neoplastic entities - Filter for entries where at least one reference matches the query
stagedEntitiesIds.beginsWith query string No Staged neoplastic entities - Filter for entries starting with the text
stagedEntitiesIds.contains query string No Staged neoplastic entities - Filter for partial text matches
stagedEntitiesIds.endsWith query string No Staged neoplastic entities - Filter for entries ending with the text
stagedEntitiesIds.exists query boolean No Staged neoplastic entities - Filter for entries with a value
stagedEntitiesIds.not query string No Staged neoplastic entities - Filter for full text mismatches
stagedEntitiesIds.not.anyOf query array No Staged neoplastic entities - Filter for entries where at least one reference mismatches the query
stagedEntitiesIds.not.beginsWith query string No Staged neoplastic entities - Filter for entries not starting with the text
stagedEntitiesIds.not.contains query string No Staged neoplastic entities - Filter for partial text mismatches
stagedEntitiesIds.not.endsWith query string No Staged neoplastic entities - Filter for entries not ending with the text
stagedEntitiesIds.not.exists query boolean No Staged neoplastic entities - Filter for entries without a value
stagingDomain query None No Staging domain - Filter for single value choice
stagingDomain.anyOf query array No Staging domain - ('Filter for excluding a subset of value choices',)
stagingDomain.not query None No Staging domain - ('Filter for all but a single value choice',)
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        null
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/AnyStaging"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[AnyStaging]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/stagings

Create Staging

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/TNMStagingCreate"
        },
        {
            "$ref": "#/components/schemas/FIGOStagingCreate"
        },
        {
            "$ref": "#/components/schemas/BinetStagingCreate"
        },
        {
            "$ref": "#/components/schemas/RaiStagingCreate"
        },
        {
            "$ref": "#/components/schemas/BreslowDepthCreate"
        },
        {
            "$ref": "#/components/schemas/ClarkStagingCreate"
        },
        {
            "$ref": "#/components/schemas/ISSStagingCreate"
        },
        {
            "$ref": "#/components/schemas/RISSStagingCreate"
        },
        {
            "$ref": "#/components/schemas/GleasonGradeCreate"
        },
        {
            "$ref": "#/components/schemas/INSSStageCreate"
        },
        {
            "$ref": "#/components/schemas/INRGSSStageCreate"
        },
        {
            "$ref": "#/components/schemas/WilmsStageCreate"
        },
        {
            "$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
        },
        {
            "$ref": "#/components/schemas/LymphomaStagingCreate"
        }
    ],
    "title": "Payload"
}

Response 201 Created

{
    "id": "085075c7-780a-4149-9975-646257d7d398",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/stagings/{stagingId}

Get Staging By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
stagingId path string No

Response 200 OK

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/TNMStaging"
        },
        {
            "$ref": "#/components/schemas/FIGOStaging"
        },
        {
            "$ref": "#/components/schemas/BinetStaging"
        },
        {
            "$ref": "#/components/schemas/RaiStaging"
        },
        {
            "$ref": "#/components/schemas/BreslowDepth"
        },
        {
            "$ref": "#/components/schemas/ClarkStaging"
        },
        {
            "$ref": "#/components/schemas/ISSStaging"
        },
        {
            "$ref": "#/components/schemas/RISSStaging"
        },
        {
            "$ref": "#/components/schemas/GleasonGrade"
        },
        {
            "$ref": "#/components/schemas/INSSStage"
        },
        {
            "$ref": "#/components/schemas/INRGSSStage"
        },
        {
            "$ref": "#/components/schemas/WilmsStage"
        },
        {
            "$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroup"
        },
        {
            "$ref": "#/components/schemas/LymphomaStaging"
        }
    ]
}

Response 404 Not Found


PUT /api/v1/stagings/{stagingId}

Update Staging

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
stagingId path string No

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/TNMStagingCreate"
        },
        {
            "$ref": "#/components/schemas/FIGOStagingCreate"
        },
        {
            "$ref": "#/components/schemas/BinetStagingCreate"
        },
        {
            "$ref": "#/components/schemas/RaiStagingCreate"
        },
        {
            "$ref": "#/components/schemas/BreslowDepthCreate"
        },
        {
            "$ref": "#/components/schemas/ClarkStagingCreate"
        },
        {
            "$ref": "#/components/schemas/ISSStagingCreate"
        },
        {
            "$ref": "#/components/schemas/RISSStagingCreate"
        },
        {
            "$ref": "#/components/schemas/GleasonGradeCreate"
        },
        {
            "$ref": "#/components/schemas/INSSStageCreate"
        },
        {
            "$ref": "#/components/schemas/INRGSSStageCreate"
        },
        {
            "$ref": "#/components/schemas/WilmsStageCreate"
        },
        {
            "$ref": "#/components/schemas/RhabdomyosarcomaClinicalGroupCreate"
        },
        {
            "$ref": "#/components/schemas/LymphomaStagingCreate"
        }
    ],
    "title": "Payload"
}

Response 200 OK

{
    "id": "28e95d87-67d1-4558-bf66-80b1b78743b9",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/stagings/{stagingId}

Delete Staging

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
stagingId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/stagings/{stagingId}/history/events

Get All Staging History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
stagingId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/stagings/{stagingId}/history/events/{eventId}

Get Staging History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
stagingId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a history event within the system.\n\nAttributes:\n    id (Any): The unique identifier of the history event.\n    resourceId (Any): The unique identifier of the tracked resource.\n    category (HistoryEventCategory): The type of history event.\n    timestamp (datetime): Timestamp of the history event.\n    user (Nullable[str]): Username of the user that triggered the event, if applicable.\n    url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n    resource (Nullable[str]): Resource involved in the event, if applicable.\n    snapshot (Dict): Data snapshot at the time of the event.\n    differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n    context (Nullable[Dict]): Context surrounding the event.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEvent",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/stagings/{stagingId}/history/events/{eventId}/reversion

Revert Staging To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
stagingId path string No

Response 201 Created

{
    "id": "90ccadda-f3c0-4077-a217-9519cd3d6261",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Risk Assessments


GET /api/v1/risk-assessments

Get All Risk Assessments Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
assessedEntitiesIds query string No Assessed neoplastic entities - Filter for full text matches
assessedEntitiesIds.anyOf query array No Assessed neoplastic entities - Filter for entries where at least one reference matches the query
assessedEntitiesIds.beginsWith query string No Assessed neoplastic entities - Filter for entries starting with the text
assessedEntitiesIds.contains query string No Assessed neoplastic entities - Filter for partial text matches
assessedEntitiesIds.endsWith query string No Assessed neoplastic entities - Filter for entries ending with the text
assessedEntitiesIds.exists query boolean No Assessed neoplastic entities - Filter for entries with a value
assessedEntitiesIds.not query string No Assessed neoplastic entities - Filter for full text mismatches
assessedEntitiesIds.not.anyOf query array No Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query
assessedEntitiesIds.not.beginsWith query string No Assessed neoplastic entities - Filter for entries not starting with the text
assessedEntitiesIds.not.contains query string No Assessed neoplastic entities - Filter for partial text mismatches
assessedEntitiesIds.not.endsWith query string No Assessed neoplastic entities - Filter for entries not ending with the text
assessedEntitiesIds.not.exists query boolean No Assessed neoplastic entities - Filter for entries without a value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
methodology query string No Assessment methodology - Filter for a matching concept code
methodology.anyOf query array No Assessment methodology - Filter for a matching set of concept codes
methodology.descendantsOf query string No Assessment methodology - Filter for all child concepts of a given concepts code
methodology.not query string No Assessment methodology - Filter for a mismatching concept code
methodology.not.anyOf query array No Assessment methodology - Filter for a mismmatching set of concept codes
offset query integer 0 No
ordering query None No
risk query string No Risk - Filter for a matching concept code
risk.anyOf query array No Risk - Filter for a matching set of concept codes
risk.descendantsOf query string No Risk - Filter for all child concepts of a given concepts code
risk.not query string No Risk - Filter for a mismatching concept code
risk.not.anyOf query array No Risk - Filter for a mismmatching set of concept codes
score.between query array No Score - Filter for entries with values between two specified values (inclusive)
score.equal query number No Score - Filter for entries with values exactly equal to the specified value
score.exists query boolean No Score - Filter for entries with a value
score.greaterThan query number No Score - Filter for entries with values greater than the specified value
score.greaterThanOrEqual query number No Score - Filter for entries with values greater than or equal to the specified value
score.lessThan query number No Score - Filter for entries with values less than the specified value
score.lessThanOrEqual query number No Score - Filter for entries with values less than or equal to the specified value
score.not.between query array No Score - Filter for entries with values between two specified values (inclusive)
score.not.equal query number No Score - Filter for entries with values not equal to the specified value
score.not.exists query boolean No Score - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "4adf1e93-ec94-40d2-93ba-d5ea05b4056f",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "33f64646-cbfa-445c-9c24-c36af74fe844",
            "date": "2022-04-13",
            "methodology": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "risk": null,
            "score": 10.12,
            "assessedEntitiesIds": [
                "b217f40c-eb11-4246-b8ef-480fc716a49f"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/RiskAssessment"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[RiskAssessment]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/risk-assessments

Create Risk Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "5db9469c-600c-48ec-84f0-528ce256601a",
    "date": "2022-04-13",
    "methodology": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "risk": null,
    "score": 10.12,
    "assessedEntitiesIds": [
        "c3363f6e-938a-4cb4-b0b6-66bd45951f67"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's cancer risk is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Indicates the method or type of risk assessment",
            "title": "Assessment methodology",
            "x-terminology": "CancerRiskAssessmentMethod"
        },
        "risk": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Assessed risk",
            "title": "Risk",
            "x-terminology": "CancerRiskAssessmentClassification"
        },
        "score": {
            "description": "Quantitative score used to classify the risk",
            "title": "Score",
            "type": "number"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assessed to estimate the risk.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "methodology",
        "risk"
    ],
    "title": "RiskAssessmentCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "7e579dbe-5c48-48e0-8436-fc54c229982c",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/risk-assessments/{riskAssessmentId}

Get Risk Assessment By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
riskAssessmentId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "acd72e92-d73a-4d2f-ac97-101df013b239",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "19f2305f-64f5-44c4-9e83-9de6f9457d7d",
    "date": "2022-04-13",
    "methodology": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "risk": null,
    "score": 10.12,
    "assessedEntitiesIds": [
        "902875e6-1ca5-460c-b2f4-2eccd5535c08"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's cancer risk is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Indicates the method or type of risk assessment",
            "title": "Assessment methodology",
            "x-terminology": "CancerRiskAssessmentMethod"
        },
        "risk": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Assessed risk",
            "title": "Risk",
            "x-terminology": "CancerRiskAssessmentClassification"
        },
        "score": {
            "description": "Quantitative score used to classify the risk",
            "title": "Score",
            "type": "number"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assessed to estimate the risk.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "methodology",
        "risk"
    ],
    "title": "RiskAssessment",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/risk-assessments/{riskAssessmentId}

Update Risk Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
riskAssessmentId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "b4391ee0-e803-4dc8-8d83-c16e696ebc73",
    "date": "2022-04-13",
    "methodology": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "risk": null,
    "score": 10.12,
    "assessedEntitiesIds": [
        "24a87ad7-d95d-43fe-b3cc-ea6f810c3a3e"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's cancer risk is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the risk assessment was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Indicates the method or type of risk assessment",
            "title": "Assessment methodology",
            "x-terminology": "CancerRiskAssessmentMethod"
        },
        "risk": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Assessed risk",
            "title": "Risk",
            "x-terminology": "CancerRiskAssessmentClassification"
        },
        "score": {
            "description": "Quantitative score used to classify the risk",
            "title": "Score",
            "type": "number"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assessed to estimate the risk.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "methodology",
        "risk"
    ],
    "title": "RiskAssessmentCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "30016a0c-4450-4245-b6cd-1a9982616217",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/risk-assessments/{riskAssessmentId}

Delete Risk Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
riskAssessmentId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/risk-assessments/{riskAssessmentId}/history/events

Get All Risk Assessment History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
riskAssessmentId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}

Get Risk Assessment History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
riskAssessmentId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/risk-assessments/{riskAssessmentId}/history/events/{eventId}/reversion

Revert Risk Assessment To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
riskAssessmentId path string No

Response 201 Created

{
    "id": "6f7ac522-6ace-4406-9fcc-c3972f24aa79",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Tumor Markers


GET /api/v1/tumor-markers

Get All Tumor Markers Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
analyte query string No Analyte - Filter for a matching concept code
analyte.anyOf query array No Analyte - Filter for a matching set of concept codes
analyte.descendantsOf query string No Analyte - Filter for all child concepts of a given concepts code
analyte.not query string No Analyte - Filter for a mismatching concept code
analyte.not.anyOf query array No Analyte - Filter for a mismmatching set of concept codes
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
arbitraryConcentration.between query array No Arbitrary concentration - Filter for entries with values between two specified values (inclusive)
arbitraryConcentration.equal query number No Arbitrary concentration - Filter for entries with values exactly equal to the specified value
arbitraryConcentration.exists query boolean No Arbitrary concentration - Filter for entries with a value
arbitraryConcentration.greaterThan query number No Arbitrary concentration - Filter for entries with values greater than the specified value
arbitraryConcentration.greaterThanOrEqual query number No Arbitrary concentration - Filter for entries with values greater than or equal to the specified value
arbitraryConcentration.lessThan query number No Arbitrary concentration - Filter for entries with values less than the specified value
arbitraryConcentration.lessThanOrEqual query number No Arbitrary concentration - Filter for entries with values less than or equal to the specified value
arbitraryConcentration.not.between query array No Arbitrary concentration - Filter for entries with values between two specified values (inclusive)
arbitraryConcentration.not.equal query number No Arbitrary concentration - Filter for entries with values not equal to the specified value
arbitraryConcentration.not.exists query boolean No Arbitrary concentration - Filter for entries without a value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
combinedPositiveScore.between query array No Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive)
combinedPositiveScore.equal query number No Combined Positive Score (CPS) - Filter for entries with values exactly equal to the specified value
combinedPositiveScore.exists query boolean No Combined Positive Score (CPS) - Filter for entries with a value
combinedPositiveScore.greaterThan query number No Combined Positive Score (CPS) - Filter for entries with values greater than the specified value
combinedPositiveScore.greaterThanOrEqual query number No Combined Positive Score (CPS) - Filter for entries with values greater than or equal to the specified value
combinedPositiveScore.lessThan query number No Combined Positive Score (CPS) - Filter for entries with values less than the specified value
combinedPositiveScore.lessThanOrEqual query number No Combined Positive Score (CPS) - Filter for entries with values less than or equal to the specified value
combinedPositiveScore.not.between query array No Combined Positive Score (CPS) - Filter for entries with values between two specified values (inclusive)
combinedPositiveScore.not.equal query number No Combined Positive Score (CPS) - Filter for entries with values not equal to the specified value
combinedPositiveScore.not.exists query boolean No Combined Positive Score (CPS) - Filter for entries without a value
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Date - Filter for entries with dates after the specified value
date.before query string No Date - Filter for entries with dates before the specified value
date.between query array No Date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Date - Filter for entries with dates not matching the specified value
date.on query string No Date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
fraction.between query array No Fraction - Filter for entries with values between two specified values (inclusive)
fraction.equal query number No Fraction - Filter for entries with values exactly equal to the specified value
fraction.exists query boolean No Fraction - Filter for entries with a value
fraction.greaterThan query number No Fraction - Filter for entries with values greater than the specified value
fraction.greaterThanOrEqual query number No Fraction - Filter for entries with values greater than or equal to the specified value
fraction.lessThan query number No Fraction - Filter for entries with values less than the specified value
fraction.lessThanOrEqual query number No Fraction - Filter for entries with values less than or equal to the specified value
fraction.not.between query array No Fraction - Filter for entries with values between two specified values (inclusive)
fraction.not.equal query number No Fraction - Filter for entries with values not equal to the specified value
fraction.not.exists query boolean No Fraction - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
immuneCellScore query None No Immune Cells Score (ICS) - Filter for single value choice
immuneCellScore.anyOf query array No Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',)
immuneCellScore.exists query boolean No Immune Cells Score (ICS) - Filter for entries with a value
immuneCellScore.not query None No Immune Cells Score (ICS) - ('Filter for all but a single value choice',)
immuneCellScore.not.exists query boolean No Immune Cells Score (ICS) - Filter for entries without a value
immunohistochemicalScore query None No Immunohistochemical Score - Filter for single value choice
immunohistochemicalScore.anyOf query array No Immunohistochemical Score - ('Filter for excluding a subset of value choices',)
immunohistochemicalScore.exists query boolean No Immunohistochemical Score - Filter for entries with a value
immunohistochemicalScore.not query None No Immunohistochemical Score - ('Filter for all but a single value choice',)
immunohistochemicalScore.not.exists query boolean No Immunohistochemical Score - Filter for entries without a value
limit query integer 10 No
massConcentration.between query array No Mass concentration - Filter for entries with values between two specified values (inclusive)
massConcentration.equal query number No Mass concentration - Filter for entries with values exactly equal to the specified value
massConcentration.exists query boolean No Mass concentration - Filter for entries with a value
massConcentration.greaterThan query number No Mass concentration - Filter for entries with values greater than the specified value
massConcentration.greaterThanOrEqual query number No Mass concentration - Filter for entries with values greater than or equal to the specified value
massConcentration.lessThan query number No Mass concentration - Filter for entries with values less than the specified value
massConcentration.lessThanOrEqual query number No Mass concentration - Filter for entries with values less than or equal to the specified value
massConcentration.not.between query array No Mass concentration - Filter for entries with values between two specified values (inclusive)
massConcentration.not.equal query number No Mass concentration - Filter for entries with values not equal to the specified value
massConcentration.not.exists query boolean No Mass concentration - Filter for entries without a value
multipleOfMedian.between query array No Multiples of the median - Filter for entries with values between two specified values (inclusive)
multipleOfMedian.equal query number No Multiples of the median - Filter for entries with values exactly equal to the specified value
multipleOfMedian.exists query boolean No Multiples of the median - Filter for entries with a value
multipleOfMedian.greaterThan query number No Multiples of the median - Filter for entries with values greater than the specified value
multipleOfMedian.greaterThanOrEqual query number No Multiples of the median - Filter for entries with values greater than or equal to the specified value
multipleOfMedian.lessThan query number No Multiples of the median - Filter for entries with values less than the specified value
multipleOfMedian.lessThanOrEqual query number No Multiples of the median - Filter for entries with values less than or equal to the specified value
multipleOfMedian.not.between query array No Multiples of the median - Filter for entries with values between two specified values (inclusive)
multipleOfMedian.not.equal query number No Multiples of the median - Filter for entries with values not equal to the specified value
multipleOfMedian.not.exists query boolean No Multiples of the median - Filter for entries without a value
nuclearExpressionStatus query None No Nuclear expression status - Filter for single value choice
nuclearExpressionStatus.anyOf query array No Nuclear expression status - ('Filter for excluding a subset of value choices',)
nuclearExpressionStatus.exists query boolean No Nuclear expression status - Filter for entries with a value
nuclearExpressionStatus.not query None No Nuclear expression status - ('Filter for all but a single value choice',)
nuclearExpressionStatus.not.exists query boolean No Nuclear expression status - Filter for entries without a value
offset query integer 0 No
ordering query None No
presence query None No Presence - Filter for single value choice
presence.anyOf query array No Presence - ('Filter for excluding a subset of value choices',)
presence.exists query boolean No Presence - Filter for entries with a value
presence.not query None No Presence - ('Filter for all but a single value choice',)
presence.not.exists query boolean No Presence - Filter for entries without a value
relatedEntitiesIds query string No Related neoplastic entities - Filter for full text matches
relatedEntitiesIds.anyOf query array No Related neoplastic entities - Filter for entries where at least one reference matches the query
relatedEntitiesIds.beginsWith query string No Related neoplastic entities - Filter for entries starting with the text
relatedEntitiesIds.contains query string No Related neoplastic entities - Filter for partial text matches
relatedEntitiesIds.endsWith query string No Related neoplastic entities - Filter for entries ending with the text
relatedEntitiesIds.exists query boolean No Related neoplastic entities - Filter for entries with a value
relatedEntitiesIds.not query string No Related neoplastic entities - Filter for full text mismatches
relatedEntitiesIds.not.anyOf query array No Related neoplastic entities - Filter for entries where at least one reference mismatches the query
relatedEntitiesIds.not.beginsWith query string No Related neoplastic entities - Filter for entries not starting with the text
relatedEntitiesIds.not.contains query string No Related neoplastic entities - Filter for partial text mismatches
relatedEntitiesIds.not.endsWith query string No Related neoplastic entities - Filter for entries not ending with the text
relatedEntitiesIds.not.exists query boolean No Related neoplastic entities - Filter for entries without a value
substanceConcentration.between query array No Substance concentration - Filter for entries with values between two specified values (inclusive)
substanceConcentration.equal query number No Substance concentration - Filter for entries with values exactly equal to the specified value
substanceConcentration.exists query boolean No Substance concentration - Filter for entries with a value
substanceConcentration.greaterThan query number No Substance concentration - Filter for entries with values greater than the specified value
substanceConcentration.greaterThanOrEqual query number No Substance concentration - Filter for entries with values greater than or equal to the specified value
substanceConcentration.lessThan query number No Substance concentration - Filter for entries with values less than the specified value
substanceConcentration.lessThanOrEqual query number No Substance concentration - Filter for entries with values less than or equal to the specified value
substanceConcentration.not.between query array No Substance concentration - Filter for entries with values between two specified values (inclusive)
substanceConcentration.not.equal query number No Substance concentration - Filter for entries with values not equal to the specified value
substanceConcentration.not.exists query boolean No Substance concentration - Filter for entries without a value
tumorProportionScore query None No Immune Cells Score (ICS) - Filter for single value choice
tumorProportionScore.anyOf query array No Immune Cells Score (ICS) - ('Filter for excluding a subset of value choices',)
tumorProportionScore.exists query boolean No Immune Cells Score (ICS) - Filter for entries with a value
tumorProportionScore.not query None No Immune Cells Score (ICS) - ('Filter for all but a single value choice',)
tumorProportionScore.not.exists query boolean No Immune Cells Score (ICS) - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "f37d38ce-1c0e-46c0-9ae5-036de7ba6cf8",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "86c26833-8e30-411e-9b17-3061a59f8448",
            "date": "2022-04-13",
            "analyte": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "massConcentration": null,
            "arbitraryConcentration": null,
            "substanceConcentration": null,
            "fraction": null,
            "multipleOfMedian": null,
            "tumorProportionScore": null,
            "immuneCellScore": null,
            "combinedPositiveScore": null,
            "immunohistochemicalScore": null,
            "presence": null,
            "nuclearExpressionStatus": null,
            "relatedEntitiesIds": [
                "64b9c7dd-3bef-4185-a0d5-24a9e1690783"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/TumorMarker"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[TumorMarker]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/tumor-markers

Create Tumor Marker

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "8accc2fa-58da-4f86-9fd2-ffcd4b316612",
    "date": "2022-04-13",
    "analyte": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "massConcentration": null,
    "arbitraryConcentration": null,
    "substanceConcentration": null,
    "fraction": null,
    "multipleOfMedian": null,
    "tumorProportionScore": null,
    "immuneCellScore": null,
    "combinedPositiveScore": null,
    "immunohistochemicalScore": null,
    "presence": null,
    "nuclearExpressionStatus": null,
    "relatedEntitiesIds": [
        "671b552e-ddd6-4253-8477-fbe8ef8cd543"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient related to the tumor marker result",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the tumor marker was analyzed.",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "analyte": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The chemical or biological substance/agent that is analyzed.",
            "title": "Analyte",
            "x-terminology": "TumorMarkerAnalyte"
        },
        "massConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Mass concentration of the analyte (if revelant/measured)",
            "title": "Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "arbitraryConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Arbitrary concentration of the analyte (if revelant/measured)",
            "title": "Arbitrary concentration",
            "x-default-unit": "kIU/l",
            "x-measure": "ArbitraryConcentration"
        },
        "substanceConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Substance concentration of the analyte (if revelant/measured)",
            "title": "Substance concentration",
            "x-default-unit": "mol/l",
            "x-measure": "SubstanceConcentration"
        },
        "fraction": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Analyte fraction (if revelant/measured)",
            "title": "Fraction",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "multipleOfMedian": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Multiples of the median analyte (if revelant/measured)",
            "title": "Multiples of the median",
            "x-default-unit": "multiple_of_median",
            "x-measure": "MultipleOfMedian"
        },
        "tumorProportionScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of cells in a tumor that express PD-L1",
            "title": "Immune Cells Score (ICS)"
        },
        "immuneCellScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of PD-L1 positive immune cells",
            "title": "Immune Cells Score (ICS)"
        },
        "combinedPositiveScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
            "title": "Combined Positive Score (CPS)",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "immunohistochemicalScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
                }
            ],
            "description": "Categorization of the number of analyte-positive cells in a sample",
            "title": "Immunohistochemical Score"
        },
        "presence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerPresenceChoices"
                }
            ],
            "description": "Whether an analyte has tested positive or negative.",
            "title": "Presence"
        },
        "nuclearExpressionStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
                }
            ],
            "description": "Categorization of the status of expression of the analyte",
            "title": "Nuclear expression status"
        },
        "relatedEntitiesIds": {
            "description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Related neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "analyte"
    ],
    "title": "TumorMarkerCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "4c990638-fbe6-4f19-b34a-db23714ea602",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-markers/{tumorMarkerId}

Get Tumor Marker By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
tumorMarkerId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "56b5b406-f2c5-4199-b55e-1ec170a6efeb",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "3af6dcf4-ce5c-4b6f-ba7d-1868b97bef39",
    "date": "2022-04-13",
    "analyte": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "massConcentration": null,
    "arbitraryConcentration": null,
    "substanceConcentration": null,
    "fraction": null,
    "multipleOfMedian": null,
    "tumorProportionScore": null,
    "immuneCellScore": null,
    "combinedPositiveScore": null,
    "immunohistochemicalScore": null,
    "presence": null,
    "nuclearExpressionStatus": null,
    "relatedEntitiesIds": [
        "7da3daef-3608-4329-90d4-c94f93254968"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient related to the tumor marker result",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the tumor marker was analyzed.",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "analyte": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The chemical or biological substance/agent that is analyzed.",
            "title": "Analyte",
            "x-terminology": "TumorMarkerAnalyte"
        },
        "massConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Mass concentration of the analyte (if revelant/measured)",
            "title": "Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "arbitraryConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Arbitrary concentration of the analyte (if revelant/measured)",
            "title": "Arbitrary concentration",
            "x-default-unit": "kIU/l",
            "x-measure": "ArbitraryConcentration"
        },
        "substanceConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Substance concentration of the analyte (if revelant/measured)",
            "title": "Substance concentration",
            "x-default-unit": "mol/l",
            "x-measure": "SubstanceConcentration"
        },
        "fraction": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Analyte fraction (if revelant/measured)",
            "title": "Fraction",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "multipleOfMedian": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Multiples of the median analyte (if revelant/measured)",
            "title": "Multiples of the median",
            "x-default-unit": "multiple_of_median",
            "x-measure": "MultipleOfMedian"
        },
        "tumorProportionScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of cells in a tumor that express PD-L1",
            "title": "Immune Cells Score (ICS)"
        },
        "immuneCellScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of PD-L1 positive immune cells",
            "title": "Immune Cells Score (ICS)"
        },
        "combinedPositiveScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
            "title": "Combined Positive Score (CPS)",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "immunohistochemicalScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
                }
            ],
            "description": "Categorization of the number of analyte-positive cells in a sample",
            "title": "Immunohistochemical Score"
        },
        "presence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerPresenceChoices"
                }
            ],
            "description": "Whether an analyte has tested positive or negative.",
            "title": "Presence"
        },
        "nuclearExpressionStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
                }
            ],
            "description": "Categorization of the status of expression of the analyte",
            "title": "Nuclear expression status"
        },
        "relatedEntitiesIds": {
            "description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Related neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "analyte"
    ],
    "title": "TumorMarker",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/tumor-markers/{tumorMarkerId}

Update Neoplastic Entity

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorMarkerId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "95cc80f1-fe67-4fdb-a929-3137a0508f6b",
    "date": "2022-04-13",
    "analyte": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "massConcentration": null,
    "arbitraryConcentration": null,
    "substanceConcentration": null,
    "fraction": null,
    "multipleOfMedian": null,
    "tumorProportionScore": null,
    "immuneCellScore": null,
    "combinedPositiveScore": null,
    "immunohistochemicalScore": null,
    "presence": null,
    "nuclearExpressionStatus": null,
    "relatedEntitiesIds": [
        "9334346c-f632-4a79-9db5-918c28600baf"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient related to the tumor marker result",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the tumor marker was analyzed.",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "analyte": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The chemical or biological substance/agent that is analyzed.",
            "title": "Analyte",
            "x-terminology": "TumorMarkerAnalyte"
        },
        "massConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Mass concentration of the analyte (if revelant/measured)",
            "title": "Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "arbitraryConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Arbitrary concentration of the analyte (if revelant/measured)",
            "title": "Arbitrary concentration",
            "x-default-unit": "kIU/l",
            "x-measure": "ArbitraryConcentration"
        },
        "substanceConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Substance concentration of the analyte (if revelant/measured)",
            "title": "Substance concentration",
            "x-default-unit": "mol/l",
            "x-measure": "SubstanceConcentration"
        },
        "fraction": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Analyte fraction (if revelant/measured)",
            "title": "Fraction",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "multipleOfMedian": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Multiples of the median analyte (if revelant/measured)",
            "title": "Multiples of the median",
            "x-default-unit": "multiple_of_median",
            "x-measure": "MultipleOfMedian"
        },
        "tumorProportionScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerTumorProportionScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of cells in a tumor that express PD-L1",
            "title": "Immune Cells Score (ICS)"
        },
        "immuneCellScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmuneCellScoreChoices"
                }
            ],
            "description": "Categorization of the percentage of PD-L1 positive immune cells",
            "title": "Immune Cells Score (ICS)"
        },
        "combinedPositiveScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "The number of PD-L1 positive cells, including tumor cells, lymphocytes, and macrophages divided by the total number of viable tumor cells multiplied by 100",
            "title": "Combined Positive Score (CPS)",
            "x-default-unit": "%",
            "x-measure": "Fraction"
        },
        "immunohistochemicalScore": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerImmunohistochemicalScoreChoices"
                }
            ],
            "description": "Categorization of the number of analyte-positive cells in a sample",
            "title": "Immunohistochemical Score"
        },
        "presence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerPresenceChoices"
                }
            ],
            "description": "Whether an analyte has tested positive or negative.",
            "title": "Presence"
        },
        "nuclearExpressionStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TumorMarkerNuclearExpressionStatusChoices"
                }
            ],
            "description": "Categorization of the status of expression of the analyte",
            "title": "Nuclear expression status"
        },
        "relatedEntitiesIds": {
            "description": "References to the neoplastic entities that are related or the focus of the tumor marker analysis.",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Related neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "analyte"
    ],
    "title": "TumorMarkerCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "f04b431a-2b9b-4dda-9566-85ed4c9b1a4f",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/tumor-markers/{tumorMarkerId}

Delete Tumor Marker

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorMarkerId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-markers/{tumorMarkerId}/history/events

Get All Tumor Marker History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
tumorMarkerId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}

Get Tumor Marker History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
tumorMarkerId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/tumor-markers/{tumorMarkerId}/history/events/{eventId}/reversion

Revert Tumor Marker To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
tumorMarkerId path string No

Response 201 Created

{
    "id": "9c8a4a24-adf2-41ff-8ea9-52aa62942e2b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-markers/analytes/{analyteCode}/details

Get Tumor Marker Analyte Details By Code

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
analyteCode path string No

Response 200 OK

{
    "acronym": "string",
    "display": "string",
    "valueTypes": [
        "MassConcentration"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents details about a tumor marker analyte.\n\nAttributes:\n    acronym (str): The acronym or short name for the analyte.\n    display (str): The display name or description of the analyte.\n    valueTypes (List[AnalyteResultType]): List of possible result types for the analyte.",
    "properties": {
        "acronym": {
            "title": "Acronym",
            "type": "string"
        },
        "display": {
            "title": "Display",
            "type": "string"
        },
        "valueTypes": {
            "items": {
                "$ref": "#/components/schemas/AnalyteResultType"
            },
            "title": "Valuetypes",
            "type": "array"
        }
    },
    "required": [
        "acronym",
        "display",
        "valueTypes"
    ],
    "title": "AnalyteDetails",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Systemic Therapies


GET /api/v1/systemic-therapies

Get All Systemic Therapies Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adjunctiveRole query string No Treatment Role - Filter for a matching concept code
adjunctiveRole.anyOf query array No Treatment Role - Filter for a matching set of concept codes
adjunctiveRole.descendantsOf query string No Treatment Role - Filter for all child concepts of a given concepts code
adjunctiveRole.exists query boolean No Treatment Role - Filter for entries with a value
adjunctiveRole.not query string No Treatment Role - Filter for a mismatching concept code
adjunctiveRole.not.anyOf query array No Treatment Role - Filter for a mismmatching set of concept codes
adjunctiveRole.not.exists query boolean No Treatment Role - Filter for entries without a value
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
cycles.between query array No Cycles - Filter for entries with values between two specified values (inclusive)
cycles.equal query integer No Cycles - Filter for entries with values exactly equal to the specified value
cycles.exists query boolean No Cycles - Filter for entries with a value
cycles.greaterThan query integer No Cycles - Filter for entries with values greater than the specified value
cycles.greaterThanOrEqual query integer No Cycles - Filter for entries with values greater than or equal to the specified value
cycles.lessThan query integer No Cycles - Filter for entries with values less than the specified value
cycles.lessThanOrEqual query integer No Cycles - Filter for entries with values less than or equal to the specified value
cycles.not.between query array No Cycles - Filter for entries with values between two specified values (inclusive)
cycles.not.equal query integer No Cycles - Filter for entries with values not equal to the specified value
cycles.not.exists query boolean No Cycles - Filter for entries without a value
duration.between query array No Duration - Filter for entries with values between two specified values (inclusive)
duration.equal query number No Duration - Filter for entries with values exactly equal to the specified value
duration.greaterThan query number No Duration - Filter for entries with values greater than the specified value
duration.greaterThanOrEqual query number No Duration - Filter for entries with values greater than or equal to the specified value
duration.lessThan query number No Duration - Filter for entries with values less than the specified value
duration.lessThanOrEqual query number No Duration - Filter for entries with values less than or equal to the specified value
duration.not.between query array No Duration - Filter for entries with values between two specified values (inclusive)
duration.not.equal query number No Duration - Filter for entries with values not equal to the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
intent query None No Intent - Filter for single value choice
intent.anyOf query array No Intent - ('Filter for excluding a subset of value choices',)
intent.not query None No Intent - ('Filter for all but a single value choice',)
isAdjunctive query boolean No Treatment Role - Filter for yes/no statement
limit query integer 10 No
medications.createdAt.after query string No Created at - Filter for entries with dates after the specified value
medications.createdAt.before query string No Created at - Filter for entries with dates before the specified value
medications.createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
medications.createdAt.exists query boolean No Created at - Filter for entries with a value
medications.createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
medications.createdAt.not.exists query boolean No Created at - Filter for entries without a value
medications.createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
medications.createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
medications.createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
medications.createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
medications.dosageMass.between query array No Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive)
medications.dosageMass.equal query number No Dosage - Fixed Mass - Filter for entries with values exactly equal to the specified value
medications.dosageMass.exists query boolean No Dosage - Fixed Mass - Filter for entries with a value
medications.dosageMass.greaterThan query number No Dosage - Fixed Mass - Filter for entries with values greater than the specified value
medications.dosageMass.greaterThanOrEqual query number No Dosage - Fixed Mass - Filter for entries with values greater than or equal to the specified value
medications.dosageMass.lessThan query number No Dosage - Fixed Mass - Filter for entries with values less than the specified value
medications.dosageMass.lessThanOrEqual query number No Dosage - Fixed Mass - Filter for entries with values less than or equal to the specified value
medications.dosageMass.not.between query array No Dosage - Fixed Mass - Filter for entries with values between two specified values (inclusive)
medications.dosageMass.not.equal query number No Dosage - Fixed Mass - Filter for entries with values not equal to the specified value
medications.dosageMass.not.exists query boolean No Dosage - Fixed Mass - Filter for entries without a value
medications.dosageMassConcentration.between query array No Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive)
medications.dosageMassConcentration.equal query number No Dosage - Mass concentration - Filter for entries with values exactly equal to the specified value
medications.dosageMassConcentration.exists query boolean No Dosage - Mass concentration - Filter for entries with a value
medications.dosageMassConcentration.greaterThan query number No Dosage - Mass concentration - Filter for entries with values greater than the specified value
medications.dosageMassConcentration.greaterThanOrEqual query number No Dosage - Mass concentration - Filter for entries with values greater than or equal to the specified value
medications.dosageMassConcentration.lessThan query number No Dosage - Mass concentration - Filter for entries with values less than the specified value
medications.dosageMassConcentration.lessThanOrEqual query number No Dosage - Mass concentration - Filter for entries with values less than or equal to the specified value
medications.dosageMassConcentration.not.between query array No Dosage - Mass concentration - Filter for entries with values between two specified values (inclusive)
medications.dosageMassConcentration.not.equal query number No Dosage - Mass concentration - Filter for entries with values not equal to the specified value
medications.dosageMassConcentration.not.exists query boolean No Dosage - Mass concentration - Filter for entries without a value
medications.dosageMassSurface.between query array No Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive)
medications.dosageMassSurface.equal query number No Dosage - Mass per body surface - Filter for entries with values exactly equal to the specified value
medications.dosageMassSurface.exists query boolean No Dosage - Mass per body surface - Filter for entries with a value
medications.dosageMassSurface.greaterThan query number No Dosage - Mass per body surface - Filter for entries with values greater than the specified value
medications.dosageMassSurface.greaterThanOrEqual query number No Dosage - Mass per body surface - Filter for entries with values greater than or equal to the specified value
medications.dosageMassSurface.lessThan query number No Dosage - Mass per body surface - Filter for entries with values less than the specified value
medications.dosageMassSurface.lessThanOrEqual query number No Dosage - Mass per body surface - Filter for entries with values less than or equal to the specified value
medications.dosageMassSurface.not.between query array No Dosage - Mass per body surface - Filter for entries with values between two specified values (inclusive)
medications.dosageMassSurface.not.equal query number No Dosage - Mass per body surface - Filter for entries with values not equal to the specified value
medications.dosageMassSurface.not.exists query boolean No Dosage - Mass per body surface - Filter for entries without a value
medications.dosageRateMass.between query array No Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMass.equal query number No Dosage rate - Fixed Mass - Filter for entries with values exactly equal to the specified value
medications.dosageRateMass.exists query boolean No Dosage rate - Fixed Mass - Filter for entries with a value
medications.dosageRateMass.greaterThan query number No Dosage rate - Fixed Mass - Filter for entries with values greater than the specified value
medications.dosageRateMass.greaterThanOrEqual query number No Dosage rate - Fixed Mass - Filter for entries with values greater than or equal to the specified value
medications.dosageRateMass.lessThan query number No Dosage rate - Fixed Mass - Filter for entries with values less than the specified value
medications.dosageRateMass.lessThanOrEqual query number No Dosage rate - Fixed Mass - Filter for entries with values less than or equal to the specified value
medications.dosageRateMass.not.between query array No Dosage rate - Fixed Mass - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMass.not.equal query number No Dosage rate - Fixed Mass - Filter for entries with values not equal to the specified value
medications.dosageRateMass.not.exists query boolean No Dosage rate - Fixed Mass - Filter for entries without a value
medications.dosageRateMassConcentration.between query array No Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMassConcentration.equal query number No Dosage rate - Mass concentration - Filter for entries with values exactly equal to the specified value
medications.dosageRateMassConcentration.exists query boolean No Dosage rate - Mass concentration - Filter for entries with a value
medications.dosageRateMassConcentration.greaterThan query number No Dosage rate - Mass concentration - Filter for entries with values greater than the specified value
medications.dosageRateMassConcentration.greaterThanOrEqual query number No Dosage rate - Mass concentration - Filter for entries with values greater than or equal to the specified value
medications.dosageRateMassConcentration.lessThan query number No Dosage rate - Mass concentration - Filter for entries with values less than the specified value
medications.dosageRateMassConcentration.lessThanOrEqual query number No Dosage rate - Mass concentration - Filter for entries with values less than or equal to the specified value
medications.dosageRateMassConcentration.not.between query array No Dosage rate - Mass concentration - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMassConcentration.not.equal query number No Dosage rate - Mass concentration - Filter for entries with values not equal to the specified value
medications.dosageRateMassConcentration.not.exists query boolean No Dosage rate - Mass concentration - Filter for entries without a value
medications.dosageRateMassSurface.between query array No Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMassSurface.equal query number No Dosage rate - Mass per body surface - Filter for entries with values exactly equal to the specified value
medications.dosageRateMassSurface.exists query boolean No Dosage rate - Mass per body surface - Filter for entries with a value
medications.dosageRateMassSurface.greaterThan query number No Dosage rate - Mass per body surface - Filter for entries with values greater than the specified value
medications.dosageRateMassSurface.greaterThanOrEqual query number No Dosage rate - Mass per body surface - Filter for entries with values greater than or equal to the specified value
medications.dosageRateMassSurface.lessThan query number No Dosage rate - Mass per body surface - Filter for entries with values less than the specified value
medications.dosageRateMassSurface.lessThanOrEqual query number No Dosage rate - Mass per body surface - Filter for entries with values less than or equal to the specified value
medications.dosageRateMassSurface.not.between query array No Dosage rate - Mass per body surface - Filter for entries with values between two specified values (inclusive)
medications.dosageRateMassSurface.not.equal query number No Dosage rate - Mass per body surface - Filter for entries with values not equal to the specified value
medications.dosageRateMassSurface.not.exists query boolean No Dosage rate - Mass per body surface - Filter for entries without a value
medications.dosageRateVolume.between query array No Dosage rate - Volume - Filter for entries with values between two specified values (inclusive)
medications.dosageRateVolume.equal query number No Dosage rate - Volume - Filter for entries with values exactly equal to the specified value
medications.dosageRateVolume.exists query boolean No Dosage rate - Volume - Filter for entries with a value
medications.dosageRateVolume.greaterThan query number No Dosage rate - Volume - Filter for entries with values greater than the specified value
medications.dosageRateVolume.greaterThanOrEqual query number No Dosage rate - Volume - Filter for entries with values greater than or equal to the specified value
medications.dosageRateVolume.lessThan query number No Dosage rate - Volume - Filter for entries with values less than the specified value
medications.dosageRateVolume.lessThanOrEqual query number No Dosage rate - Volume - Filter for entries with values less than or equal to the specified value
medications.dosageRateVolume.not.between query array No Dosage rate - Volume - Filter for entries with values between two specified values (inclusive)
medications.dosageRateVolume.not.equal query number No Dosage rate - Volume - Filter for entries with values not equal to the specified value
medications.dosageRateVolume.not.exists query boolean No Dosage rate - Volume - Filter for entries without a value
medications.dosageVolume.between query array No Dosage - Volume - Filter for entries with values between two specified values (inclusive)
medications.dosageVolume.equal query number No Dosage - Volume - Filter for entries with values exactly equal to the specified value
medications.dosageVolume.exists query boolean No Dosage - Volume - Filter for entries with a value
medications.dosageVolume.greaterThan query number No Dosage - Volume - Filter for entries with values greater than the specified value
medications.dosageVolume.greaterThanOrEqual query number No Dosage - Volume - Filter for entries with values greater than or equal to the specified value
medications.dosageVolume.lessThan query number No Dosage - Volume - Filter for entries with values less than the specified value
medications.dosageVolume.lessThanOrEqual query number No Dosage - Volume - Filter for entries with values less than or equal to the specified value
medications.dosageVolume.not.between query array No Dosage - Volume - Filter for entries with values between two specified values (inclusive)
medications.dosageVolume.not.equal query number No Dosage - Volume - Filter for entries with values not equal to the specified value
medications.dosageVolume.not.exists query boolean No Dosage - Volume - Filter for entries without a value
medications.drug query string No Antineoplastic Drug - Filter for a matching concept code
medications.drug.anyOf query array No Antineoplastic Drug - Filter for a matching set of concept codes
medications.drug.descendantsOf query string No Antineoplastic Drug - Filter for all child concepts of a given concepts code
medications.drug.not query string No Antineoplastic Drug - Filter for a mismatching concept code
medications.drug.not.anyOf query array No Antineoplastic Drug - Filter for a mismmatching set of concept codes
medications.externalSource query string No External data source - Filter for full text matches
medications.externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
medications.externalSource.beginsWith query string No External data source - Filter for entries starting with the text
medications.externalSource.contains query string No External data source - Filter for partial text matches
medications.externalSource.endsWith query string No External data source - Filter for entries ending with the text
medications.externalSource.exists query boolean No External data source - Filter for entries with a value
medications.externalSource.not query string No External data source - Filter for full text mismatches
medications.externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
medications.externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
medications.externalSource.not.contains query string No External data source - Filter for partial text mismatches
medications.externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
medications.externalSource.not.exists query boolean No External data source - Filter for entries without a value
medications.id query string No Id - Filter for full text matches
medications.id.anyOf query array No Id - Filter for entries where at least one reference matches the query
medications.id.beginsWith query string No Id - Filter for entries starting with the text
medications.id.contains query string No Id - Filter for partial text matches
medications.id.endsWith query string No Id - Filter for entries ending with the text
medications.id.not query string No Id - Filter for full text mismatches
medications.id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
medications.id.not.beginsWith query string No Id - Filter for entries not starting with the text
medications.id.not.contains query string No Id - Filter for partial text mismatches
medications.id.not.endsWith query string No Id - Filter for entries not ending with the text
medications.route query string No Route - Filter for a matching concept code
medications.route.anyOf query array No Route - Filter for a matching set of concept codes
medications.route.descendantsOf query string No Route - Filter for all child concepts of a given concepts code
medications.route.exists query boolean No Route - Filter for entries with a value
medications.route.not query string No Route - Filter for a mismatching concept code
medications.route.not.anyOf query array No Route - Filter for a mismmatching set of concept codes
medications.route.not.exists query boolean No Route - Filter for entries without a value
medications.updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
medications.updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
medications.updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
medications.updatedAt.exists query boolean No Updated at - Filter for entries with a value
medications.updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
medications.updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
medications.updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
medications.updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
medications.updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
medications.updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
medications.usedOfflabel query boolean No Off-label use - Filter for yes/no statement
medications.usedOfflabel.exists query boolean No Off-label use - Filter for entries with a value
medications.usedOfflabel.not.exists query boolean No Off-label use - Filter for entries without a value
medications.withinSoc query boolean No Within SOC - Filter for yes/no statement
medications.withinSoc.exists query boolean No Within SOC - Filter for entries with a value
medications.withinSoc.not.exists query boolean No Within SOC - Filter for entries without a value
offset query integer 0 No
ordering query None No
period.containedBy query array No Treatment period - Filter for entries whose period are contined by the time period
period.contains query array No Treatment period - Filter for entries containing the time period
period.not.containedBy query array No Treatment period - Filter for entries whose period are not contined by the time period
period.not.contains query array No Treatment period - Filter for entries not containing the time period
period.not.overlaps query array No Treatment period - Filter for entries not overlapping with the time period
period.overlaps query array No Treatment period - Filter for entries overlapping with the time period
targetedEntitiesIds query string No Targeted neoplastic entities - Filter for full text matches
targetedEntitiesIds.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference matches the query
targetedEntitiesIds.beginsWith query string No Targeted neoplastic entities - Filter for entries starting with the text
targetedEntitiesIds.contains query string No Targeted neoplastic entities - Filter for partial text matches
targetedEntitiesIds.endsWith query string No Targeted neoplastic entities - Filter for entries ending with the text
targetedEntitiesIds.exists query boolean No Targeted neoplastic entities - Filter for entries with a value
targetedEntitiesIds.not query string No Targeted neoplastic entities - Filter for full text mismatches
targetedEntitiesIds.not.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query
targetedEntitiesIds.not.beginsWith query string No Targeted neoplastic entities - Filter for entries not starting with the text
targetedEntitiesIds.not.contains query string No Targeted neoplastic entities - Filter for partial text mismatches
targetedEntitiesIds.not.endsWith query string No Targeted neoplastic entities - Filter for entries not ending with the text
targetedEntitiesIds.not.exists query boolean No Targeted neoplastic entities - Filter for entries without a value
terminationReason query string No Termination reason - Filter for a matching concept code
terminationReason.anyOf query array No Termination reason - Filter for a matching set of concept codes
terminationReason.descendantsOf query string No Termination reason - Filter for all child concepts of a given concepts code
terminationReason.exists query boolean No Termination reason - Filter for entries with a value
terminationReason.not query string No Termination reason - Filter for a mismatching concept code
terminationReason.not.anyOf query array No Termination reason - Filter for a mismmatching set of concept codes
terminationReason.not.exists query boolean No Termination reason - Filter for entries without a value
therapyLineId query string No Therapy line - Filter for reference matches
therapyLineId.anyOf query array No Therapy line - Filter for entries where at least one reference matches the query
therapyLineId.beginsWith query string No Therapy line - Filter for entries starting with the text
therapyLineId.contains query string No Therapy line - Filter for partial text matches
therapyLineId.endsWith query string No Therapy line - Filter for entries ending with the text
therapyLineId.exists query boolean No Therapy line - Filter for entries with a value
therapyLineId.not query string No Therapy line - Filter for reference mismatches
therapyLineId.not.anyOf query array No Therapy line - Filter for entries where at least one reference mismatches the query
therapyLineId.not.beginsWith query string No Therapy line - Filter for entries not starting with the text
therapyLineId.not.contains query string No Therapy line - Filter for partial text mismatches
therapyLineId.not.endsWith query string No Therapy line - Filter for entries not ending with the text
therapyLineId.not.exists query boolean No Therapy line - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "569799a1-171c-463c-a338-6122f2129c17",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "c645224c-a0ce-4196-a4b7-0c7621217283",
            "period": {
                "start": "2022-04-13",
                "end": "2022-04-13"
            },
            "cycles": 0,
            "intent": "curative",
            "adjunctiveRole": null,
            "terminationReason": null,
            "therapyLineId": "fe0aef42-fe1d-4cf7-90e3-72199d637632",
            "targetedEntitiesIds": [
                "ca594a8c-69bc-4338-a4d8-9b3ec2d5f832"
            ],
            "medications": [
                {
                    "id": "786ee4c9-e003-4f34-b490-4088dda51e92",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "drug": {
                        "code": "string",
                        "system": "string",
                        "display": "string",
                        "version": "string",
                        "synonyms": [
                            "string"
                        ],
                        "properties": {}
                    },
                    "route": null,
                    "usedOfflabel": true,
                    "withinSoc": true,
                    "dosageMassConcentration": null,
                    "dosageMass": null,
                    "dosageVolume": null,
                    "dosageMassSurface": null,
                    "dosageRateMassConcentration": null,
                    "dosageRateMass": null,
                    "dosageRateVolume": null,
                    "dosageRateMassSurface": null
                }
            ],
            "isAdjunctive": true,
            "duration": {
                "value": 10.12,
                "unit": "string"
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/SystemicTherapy"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[SystemicTherapy]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/systemic-therapies

Create Systemic Therapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "028363ba-29ee-4a97-abaa-dc52eafcf6ed",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "cycles": 0,
    "intent": "curative",
    "adjunctiveRole": null,
    "terminationReason": null,
    "therapyLineId": "c83f95b2-3299-423d-81da-ce5f994abf52",
    "targetedEntitiesIds": [
        "4fd52239-8bd9-45e1-8bda-c98236a54510"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the systemic therapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the therapy was administered to the patient.",
            "title": "Treatment period"
        },
        "cycles": {
            "description": "The total number of treatment cycles during the treatment period.",
            "title": "Cycles",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/SystemicTherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "adjunctiveRole": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Indicates the role of the adjunctive therapy (if applicable).",
            "title": "Treatment Role",
            "x-terminology": "AdjunctiveTherapyRole"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the systemic therapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the systemic therapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the systemic therapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "period",
        "intent"
    ],
    "title": "SystemicTherapyCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "e97bcf37-25b2-4082-a617-177ad96076b4",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}

Get Systemic Therapy By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
systemicTherapyId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "d8a2344b-6afe-4722-8d4b-1d690693bb2f",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "64242bad-c7c4-437f-aaad-ac3e0af63c6d",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "cycles": 0,
    "intent": "curative",
    "adjunctiveRole": null,
    "terminationReason": null,
    "therapyLineId": "d0a78b51-9f93-420e-bc1f-9983e504ce1d",
    "targetedEntitiesIds": [
        "43bf94c0-6d2a-45aa-a0b6-178dae1717fa"
    ],
    "medications": [
        {
            "id": "47b81ac0-f868-41e9-9d7b-d2d74b24971e",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "drug": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "route": null,
            "usedOfflabel": true,
            "withinSoc": true,
            "dosageMassConcentration": null,
            "dosageMass": null,
            "dosageVolume": null,
            "dosageMassSurface": null,
            "dosageRateMassConcentration": null,
            "dosageRateMass": null,
            "dosageRateVolume": null,
            "dosageRateMassSurface": null
        }
    ],
    "isAdjunctive": true,
    "duration": {
        "value": 10.12,
        "unit": "string"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the systemic therapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the therapy was administered to the patient.",
            "title": "Treatment period"
        },
        "cycles": {
            "description": "The total number of treatment cycles during the treatment period.",
            "title": "Cycles",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/SystemicTherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "adjunctiveRole": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Indicates the role of the adjunctive therapy (if applicable).",
            "title": "Treatment Role",
            "x-terminology": "AdjunctiveTherapyRole"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the systemic therapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the systemic therapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the systemic therapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        },
        "medications": {
            "description": "Medications administered during the systemic therapy",
            "items": {
                "$ref": "#/components/schemas/SystemicTherapyMedication"
            },
            "title": "Medications",
            "type": "array"
        },
        "isAdjunctive": {
            "description": "Indicates whether it is adjunctive therapy instead of a primary therapy",
            "title": "Treatment Role",
            "type": "boolean"
        },
        "duration": {
            "$ref": "#/components/schemas/Measure",
            "description": "Duration of treatment",
            "title": "Duration",
            "x-default-unit": "day",
            "x-measure": "Time"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "period",
        "intent",
        "medications",
        "isAdjunctive",
        "duration"
    ],
    "title": "SystemicTherapy",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/systemic-therapies/{systemicTherapyId}

Delete Systemic Therapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
systemicTherapyId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/systemic-therapies/{systemicTherapyId}

Update Systemic Therapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
systemicTherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "5b7983fa-591f-4ca9-b3d9-ae05549a6e92",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "cycles": 0,
    "intent": "curative",
    "adjunctiveRole": null,
    "terminationReason": null,
    "therapyLineId": "df7784f5-6cef-4d09-a6af-a770fb73327e",
    "targetedEntitiesIds": [
        "9fbba076-26eb-4997-abe1-ad14088b9052"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the systemic therapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the therapy was administered to the patient.",
            "title": "Treatment period"
        },
        "cycles": {
            "description": "The total number of treatment cycles during the treatment period.",
            "title": "Cycles",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/SystemicTherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "adjunctiveRole": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Indicates the role of the adjunctive therapy (if applicable).",
            "title": "Treatment Role",
            "x-terminology": "AdjunctiveTherapyRole"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the systemic therapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the systemic therapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the systemic therapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "period",
        "intent"
    ],
    "title": "SystemicTherapyCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "21f59e15-392a-477b-8a4a-58442f478274",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events

Get All Systemic Therapy History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
systemicTherapyId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}

Get Systemic Therapy History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
systemicTherapyId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/systemic-therapies/{systemicTherapyId}/history/events/{eventId}/reversion

Revert Systemic Therapy To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
systemicTherapyId path string No

Response 201 Created

{
    "id": "a7b3bea2-10e6-48f3-afe1-f09a6c1f28ad",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/medications

Get Systemic Therapy Medications Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
systemicTherapyId path string No

Response 200 OK

[
    {
        "id": "c71247aa-b101-4faa-8109-37a9ab5c66a5",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "drug": {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        },
        "route": null,
        "usedOfflabel": true,
        "withinSoc": true,
        "dosageMassConcentration": null,
        "dosageMass": null,
        "dosageVolume": null,
        "dosageMassSurface": null,
        "dosageRateMassConcentration": null,
        "dosageRateMass": null,
        "dosageRateVolume": null,
        "dosageRateMassSurface": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/SystemicTherapyMedication"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/systemic-therapies/{systemicTherapyId}/medications

Create Systemic Therapy Medication

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
systemicTherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "drug": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "route": null,
    "usedOfflabel": true,
    "withinSoc": true,
    "dosageMassConcentration": null,
    "dosageMass": null,
    "dosageVolume": null,
    "dosageMassSurface": null,
    "dosageRateMassConcentration": null,
    "dosageRateMass": null,
    "dosageRateVolume": null,
    "dosageRateMassSurface": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "drug": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Antineoplastic drug/medication administered to the patient",
            "title": "Antineoplastic Drug",
            "x-terminology": "AntineoplasticAgent"
        },
        "route": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Drug administration route",
            "title": "Route",
            "x-terminology": "DosageRoute"
        },
        "usedOfflabel": {
            "description": "Indicates whether a medication was used off-label at the time of administration",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
            "title": "Within SOC",
            "type": "boolean"
        },
        "dosageMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage - Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "dosageMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage - Fixed Mass",
            "x-default-unit": "g",
            "x-measure": "Mass"
        },
        "dosageVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage - Volume",
            "x-default-unit": "l",
            "x-measure": "Volume"
        },
        "dosageMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage - Mass per body surface",
            "x-default-unit": "g/square_meter",
            "x-measure": "MassPerArea"
        },
        "dosageRateMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage rate - Mass concentration",
            "x-default-unit": "g/l/s",
            "x-measure": "MassConcentrationPerTime"
        },
        "dosageRateMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage rate - Fixed Mass",
            "x-default-unit": "g/s",
            "x-measure": "MassPerTime"
        },
        "dosageRateVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage rate - Volume",
            "x-default-unit": "l/s",
            "x-measure": "VolumePerTime"
        },
        "dosageRateMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage rate - Mass per body surface",
            "x-default-unit": "g/square_meter/s",
            "x-measure": "MassPerAreaPerTime"
        }
    },
    "required": [
        "drug"
    ],
    "title": "SystemicTherapyMedicationCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "d725442a-9b84-417e-8f7f-9ade955e9f0c",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}

Get Systemic Therapy Medication By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
medicationId path string No
systemicTherapyId path string No

Response 200 OK

{
    "id": "36d5a663-a66b-40c6-952b-d392dd0d1532",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "drug": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "route": null,
    "usedOfflabel": true,
    "withinSoc": true,
    "dosageMassConcentration": null,
    "dosageMass": null,
    "dosageVolume": null,
    "dosageMassSurface": null,
    "dosageRateMassConcentration": null,
    "dosageRateMass": null,
    "dosageRateVolume": null,
    "dosageRateMassSurface": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "drug": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Antineoplastic drug/medication administered to the patient",
            "title": "Antineoplastic Drug",
            "x-terminology": "AntineoplasticAgent"
        },
        "route": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Drug administration route",
            "title": "Route",
            "x-terminology": "DosageRoute"
        },
        "usedOfflabel": {
            "description": "Indicates whether a medication was used off-label at the time of administration",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
            "title": "Within SOC",
            "type": "boolean"
        },
        "dosageMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage - Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "dosageMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage - Fixed Mass",
            "x-default-unit": "g",
            "x-measure": "Mass"
        },
        "dosageVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage - Volume",
            "x-default-unit": "l",
            "x-measure": "Volume"
        },
        "dosageMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage - Mass per body surface",
            "x-default-unit": "g/square_meter",
            "x-measure": "MassPerArea"
        },
        "dosageRateMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage rate - Mass concentration",
            "x-default-unit": "g/l/s",
            "x-measure": "MassConcentrationPerTime"
        },
        "dosageRateMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage rate - Fixed Mass",
            "x-default-unit": "g/s",
            "x-measure": "MassPerTime"
        },
        "dosageRateVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage rate - Volume",
            "x-default-unit": "l/s",
            "x-measure": "VolumePerTime"
        },
        "dosageRateMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage rate - Mass per body surface",
            "x-default-unit": "g/square_meter/s",
            "x-measure": "MassPerAreaPerTime"
        }
    },
    "required": [
        "id",
        "description",
        "drug"
    ],
    "title": "SystemicTherapyMedication",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}

Update Systemic Therapy Medication

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
medicationId path string No
systemicTherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "drug": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "route": null,
    "usedOfflabel": true,
    "withinSoc": true,
    "dosageMassConcentration": null,
    "dosageMass": null,
    "dosageVolume": null,
    "dosageMassSurface": null,
    "dosageRateMassConcentration": null,
    "dosageRateMass": null,
    "dosageRateVolume": null,
    "dosageRateMassSurface": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "drug": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Antineoplastic drug/medication administered to the patient",
            "title": "Antineoplastic Drug",
            "x-terminology": "AntineoplasticAgent"
        },
        "route": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Drug administration route",
            "title": "Route",
            "x-terminology": "DosageRoute"
        },
        "usedOfflabel": {
            "description": "Indicates whether a medication was used off-label at the time of administration",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Indicates whether a medication was within standard of care (SOC) at the time of administration.",
            "title": "Within SOC",
            "type": "boolean"
        },
        "dosageMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage - Mass concentration",
            "x-default-unit": "g/l",
            "x-measure": "MassConcentration"
        },
        "dosageMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage - Fixed Mass",
            "x-default-unit": "g",
            "x-measure": "Mass"
        },
        "dosageVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage - Volume",
            "x-default-unit": "l",
            "x-measure": "Volume"
        },
        "dosageMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage - Mass per body surface",
            "x-default-unit": "g/square_meter",
            "x-measure": "MassPerArea"
        },
        "dosageRateMassConcentration": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in mass concentration (if revelant/appliccable)",
            "title": "Dosage rate - Mass concentration",
            "x-default-unit": "g/l/s",
            "x-measure": "MassConcentrationPerTime"
        },
        "dosageRateMass": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a fixed mass (if revelant/appliccable)",
            "title": "Dosage rate - Fixed Mass",
            "x-default-unit": "g/s",
            "x-measure": "MassPerTime"
        },
        "dosageRateVolume": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a volume (if revelant/appliccable)",
            "title": "Dosage rate - Volume",
            "x-default-unit": "l/s",
            "x-measure": "VolumePerTime"
        },
        "dosageRateMassSurface": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Dosage rate of the medication expressed in a mass per body surface area (if revelant/appliccable)",
            "title": "Dosage rate - Mass per body surface",
            "x-default-unit": "g/square_meter/s",
            "x-measure": "MassPerAreaPerTime"
        }
    },
    "required": [
        "drug"
    ],
    "title": "SystemicTherapyMedicationCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "d1bd58a5-66c9-4100-9e86-09a6078c4e07",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}

Delete Systemic Therapy Medication

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
medicationId path string No
systemicTherapyId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events

Get All Systemic Therapy Medication History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
medicationId path string No
offset query integer 0 No
ordering query None No
systemicTherapyId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}

Get Systemic Therapy Medication History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
medicationId path string No
systemicTherapyId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/systemic-therapies/{systemicTherapyId}/medications/{medicationId}/history/events/{eventId}/reversion

Revert Systemic Therapy Medication To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
medicationId path string No
systemicTherapyId path string No

Response 201 Created

{
    "id": "22c1dbcf-9f8c-4ab3-8e0e-472746e4b27a",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Surgeries


GET /api/v1/surgeries

Get All Surgeries Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
bodysite query string No Anatomical location - Filter for a matching concept code
bodysite.anyOf query array No Anatomical location - Filter for a matching set of concept codes
bodysite.descendantsOf query string No Anatomical location - Filter for all child concepts of a given concepts code
bodysite.exists query boolean No Anatomical location - Filter for entries with a value
bodysite.not query string No Anatomical location - Filter for a mismatching concept code
bodysite.not.anyOf query array No Anatomical location - Filter for a mismmatching set of concept codes
bodysite.not.exists query boolean No Anatomical location - Filter for entries without a value
bodysiteLaterality query string No Anatomical location laterality - Filter for a matching concept code
bodysiteLaterality.anyOf query array No Anatomical location laterality - Filter for a matching set of concept codes
bodysiteLaterality.descendantsOf query string No Anatomical location laterality - Filter for all child concepts of a given concepts code
bodysiteLaterality.exists query boolean No Anatomical location laterality - Filter for entries with a value
bodysiteLaterality.not query string No Anatomical location laterality - Filter for a mismatching concept code
bodysiteLaterality.not.anyOf query array No Anatomical location laterality - Filter for a mismmatching set of concept codes
bodysiteLaterality.not.exists query boolean No Anatomical location laterality - Filter for entries without a value
bodysiteQualifier query string No Anatomical location qualifier - Filter for a matching concept code
bodysiteQualifier.anyOf query array No Anatomical location qualifier - Filter for a matching set of concept codes
bodysiteQualifier.descendantsOf query string No Anatomical location qualifier - Filter for all child concepts of a given concepts code
bodysiteQualifier.exists query boolean No Anatomical location qualifier - Filter for entries with a value
bodysiteQualifier.not query string No Anatomical location qualifier - Filter for a mismatching concept code
bodysiteQualifier.not.anyOf query array No Anatomical location qualifier - Filter for a mismmatching set of concept codes
bodysiteQualifier.not.exists query boolean No Anatomical location qualifier - Filter for entries without a value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
intent query None No Intent - Filter for single value choice
intent.anyOf query array No Intent - ('Filter for excluding a subset of value choices',)
intent.not query None No Intent - ('Filter for all but a single value choice',)
limit query integer 10 No
offset query integer 0 No
ordering query None No
outcome query string No Outcome - Filter for a matching concept code
outcome.anyOf query array No Outcome - Filter for a matching set of concept codes
outcome.descendantsOf query string No Outcome - Filter for all child concepts of a given concepts code
outcome.exists query boolean No Outcome - Filter for entries with a value
outcome.not query string No Outcome - Filter for a mismatching concept code
outcome.not.anyOf query array No Outcome - Filter for a mismmatching set of concept codes
outcome.not.exists query boolean No Outcome - Filter for entries without a value
procedure query string No Surgical procedure - Filter for a matching concept code
procedure.anyOf query array No Surgical procedure - Filter for a matching set of concept codes
procedure.descendantsOf query string No Surgical procedure - Filter for all child concepts of a given concepts code
procedure.not query string No Surgical procedure - Filter for a mismatching concept code
procedure.not.anyOf query array No Surgical procedure - Filter for a mismmatching set of concept codes
targetedEntitiesIds query string No Targeted neoplastic entities - Filter for full text matches
targetedEntitiesIds.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference matches the query
targetedEntitiesIds.beginsWith query string No Targeted neoplastic entities - Filter for entries starting with the text
targetedEntitiesIds.contains query string No Targeted neoplastic entities - Filter for partial text matches
targetedEntitiesIds.endsWith query string No Targeted neoplastic entities - Filter for entries ending with the text
targetedEntitiesIds.exists query boolean No Targeted neoplastic entities - Filter for entries with a value
targetedEntitiesIds.not query string No Targeted neoplastic entities - Filter for full text mismatches
targetedEntitiesIds.not.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query
targetedEntitiesIds.not.beginsWith query string No Targeted neoplastic entities - Filter for entries not starting with the text
targetedEntitiesIds.not.contains query string No Targeted neoplastic entities - Filter for partial text mismatches
targetedEntitiesIds.not.endsWith query string No Targeted neoplastic entities - Filter for entries not ending with the text
targetedEntitiesIds.not.exists query boolean No Targeted neoplastic entities - Filter for entries without a value
therapyLineId query string No Therapy line - Filter for reference matches
therapyLineId.anyOf query array No Therapy line - Filter for entries where at least one reference matches the query
therapyLineId.beginsWith query string No Therapy line - Filter for entries starting with the text
therapyLineId.contains query string No Therapy line - Filter for partial text matches
therapyLineId.endsWith query string No Therapy line - Filter for entries ending with the text
therapyLineId.exists query boolean No Therapy line - Filter for entries with a value
therapyLineId.not query string No Therapy line - Filter for reference mismatches
therapyLineId.not.anyOf query array No Therapy line - Filter for entries where at least one reference mismatches the query
therapyLineId.not.beginsWith query string No Therapy line - Filter for entries not starting with the text
therapyLineId.not.contains query string No Therapy line - Filter for partial text mismatches
therapyLineId.not.endsWith query string No Therapy line - Filter for entries not ending with the text
therapyLineId.not.exists query boolean No Therapy line - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "cb5c6935-945b-4d82-a7d0-28b0675bd261",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "ee6f92b5-2c67-4c1b-81fc-13d6fa97845f",
            "date": "2022-04-13",
            "procedure": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "intent": "curative",
            "bodysite": null,
            "bodysiteQualifier": null,
            "bodysiteLaterality": null,
            "outcome": null,
            "therapyLineId": "a6aab8a9-6fb8-4478-b251-868abb5cd804",
            "targetedEntitiesIds": [
                "e91dd55e-9d8b-4fa7-ab90-93296247ceae"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Surgery"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Surgery]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/surgeries

Create Surgery

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "675527ca-e719-4ed5-8bc1-dccf30b70711",
    "date": "2022-04-13",
    "procedure": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "intent": "curative",
    "bodysite": null,
    "bodysiteQualifier": null,
    "bodysiteLaterality": null,
    "outcome": null,
    "therapyLineId": "63485578-f332-454e-b507-befcfc177dd9",
    "targetedEntitiesIds": [
        "999f0991-4ed8-45ed-9383-c642528dbafc"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the surgical procedure",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the surgical procedure.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "procedure": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The specific surgical procedure that was performed",
            "title": "Surgical procedure",
            "x-terminology": "SurgicalProcedure"
        },
        "intent": {
            "$ref": "#/components/schemas/SurgeryIntentChoices",
            "description": "Therapeutic intent of the surgery",
            "title": "Intent"
        },
        "bodysite": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Anatomical location of the surgery",
            "title": "Anatomical location",
            "x-terminology": "CancerTopography"
        },
        "bodysiteQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the surgery",
            "title": "Anatomical location qualifier",
            "x-terminology": "BodyLocationQualifier"
        },
        "bodysiteLaterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality for the anatomical location of the surgery",
            "title": "Anatomical location laterality",
            "x-terminology": "LateralityQualifier"
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The outcome of the surgery",
            "title": "Outcome",
            "x-terminology": "ProcedureOutcome"
        },
        "therapyLineId": {
            "description": "Therapy line to which the surgery is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the surgery",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "procedure",
        "intent"
    ],
    "title": "SurgeryCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "9b16f7d6-d4f1-482e-a848-aa736722782f",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/surgeries/{surgeryId}

Get Surgery By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
surgeryId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "57462c20-a14c-4bf9-bb9b-035311a89966",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "91e3cdcc-3b9a-4676-b8ba-cf08f9216588",
    "date": "2022-04-13",
    "procedure": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "intent": "curative",
    "bodysite": null,
    "bodysiteQualifier": null,
    "bodysiteLaterality": null,
    "outcome": null,
    "therapyLineId": "dbf33a51-345f-44b6-b754-1ba701ae2be6",
    "targetedEntitiesIds": [
        "ba9b3a73-5ac0-4763-84d9-b7df529d0cc1"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the surgical procedure",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the surgical procedure.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "procedure": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The specific surgical procedure that was performed",
            "title": "Surgical procedure",
            "x-terminology": "SurgicalProcedure"
        },
        "intent": {
            "$ref": "#/components/schemas/SurgeryIntentChoices",
            "description": "Therapeutic intent of the surgery",
            "title": "Intent"
        },
        "bodysite": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Anatomical location of the surgery",
            "title": "Anatomical location",
            "x-terminology": "CancerTopography"
        },
        "bodysiteQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the surgery",
            "title": "Anatomical location qualifier",
            "x-terminology": "BodyLocationQualifier"
        },
        "bodysiteLaterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality for the anatomical location of the surgery",
            "title": "Anatomical location laterality",
            "x-terminology": "LateralityQualifier"
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The outcome of the surgery",
            "title": "Outcome",
            "x-terminology": "ProcedureOutcome"
        },
        "therapyLineId": {
            "description": "Therapy line to which the surgery is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the surgery",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "procedure",
        "intent"
    ],
    "title": "Surgery",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/surgeries/{surgeryId}

Update Surgery

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
surgeryId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "ccb9449b-eefd-4f0c-8735-0da16f2d68c5",
    "date": "2022-04-13",
    "procedure": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "intent": "curative",
    "bodysite": null,
    "bodysiteQualifier": null,
    "bodysiteLaterality": null,
    "outcome": null,
    "therapyLineId": "c139b4d8-ed7d-4625-8665-dcb93bc29b58",
    "targetedEntitiesIds": [
        "d37608dc-b81d-4565-abf1-81b74631e644"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the surgical procedure",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the surgical procedure.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "procedure": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The specific surgical procedure that was performed",
            "title": "Surgical procedure",
            "x-terminology": "SurgicalProcedure"
        },
        "intent": {
            "$ref": "#/components/schemas/SurgeryIntentChoices",
            "description": "Therapeutic intent of the surgery",
            "title": "Intent"
        },
        "bodysite": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Anatomical location of the surgery",
            "title": "Anatomical location",
            "x-terminology": "CancerTopography"
        },
        "bodysiteQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the surgery",
            "title": "Anatomical location qualifier",
            "x-terminology": "BodyLocationQualifier"
        },
        "bodysiteLaterality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Laterality for the anatomical location of the surgery",
            "title": "Anatomical location laterality",
            "x-terminology": "LateralityQualifier"
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The outcome of the surgery",
            "title": "Outcome",
            "x-terminology": "ProcedureOutcome"
        },
        "therapyLineId": {
            "description": "Therapy line to which the surgery is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the surgery",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "date",
        "procedure",
        "intent"
    ],
    "title": "SurgeryCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "f79e126e-a15a-4fdc-9aca-b52817649edf",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/surgeries/{surgeryId}

Delete Surgery

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
surgeryId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/surgeries/{surgeryId}/history/events

Get All Surgery History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
surgeryId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/surgeries/{surgeryId}/history/events/{eventId}

Get Surgery History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
surgeryId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/surgeries/{surgeryId}/history/events/{eventId}/reversion

Revert Surgery To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
surgeryId path string No

Response 201 Created

{
    "id": "6d43b33f-9fcc-4dae-b202-b0354c2ead64",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Radiotherapies


GET /api/v1/radiotherapies

Get All Radiotherapies Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
dosages.createdAt.after query string No Created at - Filter for entries with dates after the specified value
dosages.createdAt.before query string No Created at - Filter for entries with dates before the specified value
dosages.createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
dosages.createdAt.exists query boolean No Created at - Filter for entries with a value
dosages.createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
dosages.createdAt.not.exists query boolean No Created at - Filter for entries without a value
dosages.createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
dosages.createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
dosages.createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
dosages.createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
dosages.dose.between query array No Total radiation dose - Filter for entries with values between two specified values (inclusive)
dosages.dose.equal query number No Total radiation dose - Filter for entries with values exactly equal to the specified value
dosages.dose.exists query boolean No Total radiation dose - Filter for entries with a value
dosages.dose.greaterThan query number No Total radiation dose - Filter for entries with values greater than the specified value
dosages.dose.greaterThanOrEqual query number No Total radiation dose - Filter for entries with values greater than or equal to the specified value
dosages.dose.lessThan query number No Total radiation dose - Filter for entries with values less than the specified value
dosages.dose.lessThanOrEqual query number No Total radiation dose - Filter for entries with values less than or equal to the specified value
dosages.dose.not.between query array No Total radiation dose - Filter for entries with values between two specified values (inclusive)
dosages.dose.not.equal query number No Total radiation dose - Filter for entries with values not equal to the specified value
dosages.dose.not.exists query boolean No Total radiation dose - Filter for entries without a value
dosages.externalSource query string No External data source - Filter for full text matches
dosages.externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
dosages.externalSource.beginsWith query string No External data source - Filter for entries starting with the text
dosages.externalSource.contains query string No External data source - Filter for partial text matches
dosages.externalSource.endsWith query string No External data source - Filter for entries ending with the text
dosages.externalSource.exists query boolean No External data source - Filter for entries with a value
dosages.externalSource.not query string No External data source - Filter for full text mismatches
dosages.externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
dosages.externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
dosages.externalSource.not.contains query string No External data source - Filter for partial text mismatches
dosages.externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
dosages.externalSource.not.exists query boolean No External data source - Filter for entries without a value
dosages.fractions.between query array No Total fractions - Filter for entries with values between two specified values (inclusive)
dosages.fractions.equal query integer No Total fractions - Filter for entries with values exactly equal to the specified value
dosages.fractions.exists query boolean No Total fractions - Filter for entries with a value
dosages.fractions.greaterThan query integer No Total fractions - Filter for entries with values greater than the specified value
dosages.fractions.greaterThanOrEqual query integer No Total fractions - Filter for entries with values greater than or equal to the specified value
dosages.fractions.lessThan query integer No Total fractions - Filter for entries with values less than the specified value
dosages.fractions.lessThanOrEqual query integer No Total fractions - Filter for entries with values less than or equal to the specified value
dosages.fractions.not.between query array No Total fractions - Filter for entries with values between two specified values (inclusive)
dosages.fractions.not.equal query integer No Total fractions - Filter for entries with values not equal to the specified value
dosages.fractions.not.exists query boolean No Total fractions - Filter for entries without a value
dosages.id query string No Id - Filter for full text matches
dosages.id.anyOf query array No Id - Filter for entries where at least one reference matches the query
dosages.id.beginsWith query string No Id - Filter for entries starting with the text
dosages.id.contains query string No Id - Filter for partial text matches
dosages.id.endsWith query string No Id - Filter for entries ending with the text
dosages.id.not query string No Id - Filter for full text mismatches
dosages.id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
dosages.id.not.beginsWith query string No Id - Filter for entries not starting with the text
dosages.id.not.contains query string No Id - Filter for partial text mismatches
dosages.id.not.endsWith query string No Id - Filter for entries not ending with the text
dosages.irradiatedVolume query string No Irradiated volume - Filter for a matching concept code
dosages.irradiatedVolume.anyOf query array No Irradiated volume - Filter for a matching set of concept codes
dosages.irradiatedVolume.descendantsOf query string No Irradiated volume - Filter for all child concepts of a given concepts code
dosages.irradiatedVolume.not query string No Irradiated volume - Filter for a mismatching concept code
dosages.irradiatedVolume.not.anyOf query array No Irradiated volume - Filter for a mismmatching set of concept codes
dosages.irradiatedVolumeMorphology query string No Irradiated volume morphology - Filter for a matching concept code
dosages.irradiatedVolumeMorphology.anyOf query array No Irradiated volume morphology - Filter for a matching set of concept codes
dosages.irradiatedVolumeMorphology.descendantsOf query string No Irradiated volume morphology - Filter for all child concepts of a given concepts code
dosages.irradiatedVolumeMorphology.exists query boolean No Irradiated volume morphology - Filter for entries with a value
dosages.irradiatedVolumeMorphology.not query string No Irradiated volume morphology - Filter for a mismatching concept code
dosages.irradiatedVolumeMorphology.not.anyOf query array No Irradiated volume morphology - Filter for a mismmatching set of concept codes
dosages.irradiatedVolumeMorphology.not.exists query boolean No Irradiated volume morphology - Filter for entries without a value
dosages.irradiatedVolumeQualifier query string No Irradiated volume qualifier - Filter for a matching concept code
dosages.irradiatedVolumeQualifier.anyOf query array No Irradiated volume qualifier - Filter for a matching set of concept codes
dosages.irradiatedVolumeQualifier.descendantsOf query string No Irradiated volume qualifier - Filter for all child concepts of a given concepts code
dosages.irradiatedVolumeQualifier.exists query boolean No Irradiated volume qualifier - Filter for entries with a value
dosages.irradiatedVolumeQualifier.not query string No Irradiated volume qualifier - Filter for a mismatching concept code
dosages.irradiatedVolumeQualifier.not.anyOf query array No Irradiated volume qualifier - Filter for a mismmatching set of concept codes
dosages.irradiatedVolumeQualifier.not.exists query boolean No Irradiated volume qualifier - Filter for entries without a value
dosages.updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
dosages.updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
dosages.updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
dosages.updatedAt.exists query boolean No Updated at - Filter for entries with a value
dosages.updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
dosages.updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
dosages.updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
dosages.updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
dosages.updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
dosages.updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
duration.between query array No Duration - Filter for entries with values between two specified values (inclusive)
duration.equal query number No Duration - Filter for entries with values exactly equal to the specified value
duration.greaterThan query number No Duration - Filter for entries with values greater than the specified value
duration.greaterThanOrEqual query number No Duration - Filter for entries with values greater than or equal to the specified value
duration.lessThan query number No Duration - Filter for entries with values less than the specified value
duration.lessThanOrEqual query number No Duration - Filter for entries with values less than or equal to the specified value
duration.not.between query array No Duration - Filter for entries with values between two specified values (inclusive)
duration.not.equal query number No Duration - Filter for entries with values not equal to the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
intent query None No Intent - Filter for single value choice
intent.anyOf query array No Intent - ('Filter for excluding a subset of value choices',)
intent.not query None No Intent - ('Filter for all but a single value choice',)
limit query integer 10 No
offset query integer 0 No
ordering query None No
period.containedBy query array No Treatment period - Filter for entries whose period are contined by the time period
period.contains query array No Treatment period - Filter for entries containing the time period
period.not.containedBy query array No Treatment period - Filter for entries whose period are not contined by the time period
period.not.contains query array No Treatment period - Filter for entries not containing the time period
period.not.overlaps query array No Treatment period - Filter for entries not overlapping with the time period
period.overlaps query array No Treatment period - Filter for entries overlapping with the time period
sessions.between query array No Total sessions - Filter for entries with values between two specified values (inclusive)
sessions.equal query integer No Total sessions - Filter for entries with values exactly equal to the specified value
sessions.greaterThan query integer No Total sessions - Filter for entries with values greater than the specified value
sessions.greaterThanOrEqual query integer No Total sessions - Filter for entries with values greater than or equal to the specified value
sessions.lessThan query integer No Total sessions - Filter for entries with values less than the specified value
sessions.lessThanOrEqual query integer No Total sessions - Filter for entries with values less than or equal to the specified value
sessions.not.between query array No Total sessions - Filter for entries with values between two specified values (inclusive)
sessions.not.equal query integer No Total sessions - Filter for entries with values not equal to the specified value
settings.createdAt.after query string No Created at - Filter for entries with dates after the specified value
settings.createdAt.before query string No Created at - Filter for entries with dates before the specified value
settings.createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
settings.createdAt.exists query boolean No Created at - Filter for entries with a value
settings.createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
settings.createdAt.not.exists query boolean No Created at - Filter for entries without a value
settings.createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
settings.createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
settings.createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
settings.createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
settings.externalSource query string No External data source - Filter for full text matches
settings.externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
settings.externalSource.beginsWith query string No External data source - Filter for entries starting with the text
settings.externalSource.contains query string No External data source - Filter for partial text matches
settings.externalSource.endsWith query string No External data source - Filter for entries ending with the text
settings.externalSource.exists query boolean No External data source - Filter for entries with a value
settings.externalSource.not query string No External data source - Filter for full text mismatches
settings.externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
settings.externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
settings.externalSource.not.contains query string No External data source - Filter for partial text mismatches
settings.externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
settings.externalSource.not.exists query boolean No External data source - Filter for entries without a value
settings.id query string No Id - Filter for full text matches
settings.id.anyOf query array No Id - Filter for entries where at least one reference matches the query
settings.id.beginsWith query string No Id - Filter for entries starting with the text
settings.id.contains query string No Id - Filter for partial text matches
settings.id.endsWith query string No Id - Filter for entries ending with the text
settings.id.not query string No Id - Filter for full text mismatches
settings.id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
settings.id.not.beginsWith query string No Id - Filter for entries not starting with the text
settings.id.not.contains query string No Id - Filter for partial text mismatches
settings.id.not.endsWith query string No Id - Filter for entries not ending with the text
settings.modality query string No Modality - Filter for a matching concept code
settings.modality.anyOf query array No Modality - Filter for a matching set of concept codes
settings.modality.descendantsOf query string No Modality - Filter for all child concepts of a given concepts code
settings.modality.not query string No Modality - Filter for a mismatching concept code
settings.modality.not.anyOf query array No Modality - Filter for a mismmatching set of concept codes
settings.technique query string No Technique - Filter for a matching concept code
settings.technique.anyOf query array No Technique - Filter for a matching set of concept codes
settings.technique.descendantsOf query string No Technique - Filter for all child concepts of a given concepts code
settings.technique.not query string No Technique - Filter for a mismatching concept code
settings.technique.not.anyOf query array No Technique - Filter for a mismmatching set of concept codes
settings.updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
settings.updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
settings.updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
settings.updatedAt.exists query boolean No Updated at - Filter for entries with a value
settings.updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
settings.updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
settings.updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
settings.updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
settings.updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
settings.updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
targetedEntitiesIds query string No Targeted neoplastic entities - Filter for full text matches
targetedEntitiesIds.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference matches the query
targetedEntitiesIds.beginsWith query string No Targeted neoplastic entities - Filter for entries starting with the text
targetedEntitiesIds.contains query string No Targeted neoplastic entities - Filter for partial text matches
targetedEntitiesIds.endsWith query string No Targeted neoplastic entities - Filter for entries ending with the text
targetedEntitiesIds.exists query boolean No Targeted neoplastic entities - Filter for entries with a value
targetedEntitiesIds.not query string No Targeted neoplastic entities - Filter for full text mismatches
targetedEntitiesIds.not.anyOf query array No Targeted neoplastic entities - Filter for entries where at least one reference mismatches the query
targetedEntitiesIds.not.beginsWith query string No Targeted neoplastic entities - Filter for entries not starting with the text
targetedEntitiesIds.not.contains query string No Targeted neoplastic entities - Filter for partial text mismatches
targetedEntitiesIds.not.endsWith query string No Targeted neoplastic entities - Filter for entries not ending with the text
targetedEntitiesIds.not.exists query boolean No Targeted neoplastic entities - Filter for entries without a value
terminationReason query string No Termination reason - Filter for a matching concept code
terminationReason.anyOf query array No Termination reason - Filter for a matching set of concept codes
terminationReason.descendantsOf query string No Termination reason - Filter for all child concepts of a given concepts code
terminationReason.exists query boolean No Termination reason - Filter for entries with a value
terminationReason.not query string No Termination reason - Filter for a mismatching concept code
terminationReason.not.anyOf query array No Termination reason - Filter for a mismmatching set of concept codes
terminationReason.not.exists query boolean No Termination reason - Filter for entries without a value
therapyLineId query string No Therapy line - Filter for reference matches
therapyLineId.anyOf query array No Therapy line - Filter for entries where at least one reference matches the query
therapyLineId.beginsWith query string No Therapy line - Filter for entries starting with the text
therapyLineId.contains query string No Therapy line - Filter for partial text matches
therapyLineId.endsWith query string No Therapy line - Filter for entries ending with the text
therapyLineId.exists query boolean No Therapy line - Filter for entries with a value
therapyLineId.not query string No Therapy line - Filter for reference mismatches
therapyLineId.not.anyOf query array No Therapy line - Filter for entries where at least one reference mismatches the query
therapyLineId.not.beginsWith query string No Therapy line - Filter for entries not starting with the text
therapyLineId.not.contains query string No Therapy line - Filter for partial text mismatches
therapyLineId.not.endsWith query string No Therapy line - Filter for entries not ending with the text
therapyLineId.not.exists query boolean No Therapy line - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "a6d300fb-638a-4445-82eb-be3213b72014",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "ccfe3d05-a9fa-4d1a-8892-e73a254aecc7",
            "period": {
                "start": "2022-04-13",
                "end": "2022-04-13"
            },
            "sessions": 0,
            "intent": "curative",
            "terminationReason": null,
            "therapyLineId": "f147a541-01bf-425d-919a-1a1bc224cc2c",
            "targetedEntitiesIds": [
                "a96776c6-a31d-4bd0-8a64-6699ae354a82"
            ],
            "duration": {
                "value": 10.12,
                "unit": "string"
            },
            "dosages": [
                {
                    "id": "5fc13d23-e52e-4618-ae44-3ff3e364d927",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "fractions": 0,
                    "dose": null,
                    "irradiatedVolume": {
                        "code": "string",
                        "system": "string",
                        "display": "string",
                        "version": "string",
                        "synonyms": [
                            "string"
                        ],
                        "properties": {}
                    },
                    "irradiatedVolumeMorphology": null,
                    "irradiatedVolumeQualifier": null
                }
            ],
            "settings": [
                {
                    "id": "8ff185f9-cced-429d-b172-eb6ae2a191f6",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "modality": null,
                    "technique": null
                }
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Radiotherapy"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Radiotherapy]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/radiotherapies

Create Radiotherapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "5e465212-f550-47fe-958a-86430e9eb9b2",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "sessions": 0,
    "intent": "curative",
    "terminationReason": null,
    "therapyLineId": "4734d0c2-60c5-43fd-8722-824922867455",
    "targetedEntitiesIds": [
        "386d3f36-602f-42c2-b713-babbfbde3baa"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the radiotherapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
            "title": "Treatment period"
        },
        "sessions": {
            "description": "The total number of radiotherapy sessions over the treatment period.",
            "title": "Total sessions",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/RadiotherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the radiotherapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the radiotherapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the radiotherapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "period",
        "sessions",
        "intent"
    ],
    "title": "RadiotherapyCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "a6465675-a1c5-4e17-a29c-1847b77254b1",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}

Get Radiotherapy By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
radiotherapyId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "e86aafc8-c4a0-4d1a-97ef-22ae89572e12",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "318ee3c6-42fe-484c-8eda-79194925df94",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "sessions": 0,
    "intent": "curative",
    "terminationReason": null,
    "therapyLineId": "dd3e2167-a6b6-4b17-b6c4-0fd738ef48c9",
    "targetedEntitiesIds": [
        "d6e4e001-216f-4527-81b4-d47f82b1ae06"
    ],
    "duration": {
        "value": 10.12,
        "unit": "string"
    },
    "dosages": [
        {
            "id": "a9cbd37a-6537-4888-9a41-dd0f41aabf94",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "fractions": 0,
            "dose": null,
            "irradiatedVolume": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "irradiatedVolumeMorphology": null,
            "irradiatedVolumeQualifier": null
        }
    ],
    "settings": [
        {
            "id": "0d80e778-20f8-45e1-90e4-604e229ffbfb",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "modality": null,
            "technique": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the radiotherapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
            "title": "Treatment period"
        },
        "sessions": {
            "description": "The total number of radiotherapy sessions over the treatment period.",
            "title": "Total sessions",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/RadiotherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the radiotherapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the radiotherapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the radiotherapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        },
        "duration": {
            "$ref": "#/components/schemas/Measure",
            "description": "Duration of treatment",
            "title": "Duration",
            "x-measure": "Time"
        },
        "dosages": {
            "description": "Radiation doses administered during the radiotherapy",
            "items": {
                "$ref": "#/components/schemas/RadiotherapyDosage"
            },
            "title": "Dosages",
            "type": "array"
        },
        "settings": {
            "description": "Settings of the radiotherapy irradiation procedure",
            "items": {
                "$ref": "#/components/schemas/RadiotherapySetting"
            },
            "title": "Settings",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "period",
        "sessions",
        "intent",
        "duration",
        "dosages",
        "settings"
    ],
    "title": "Radiotherapy",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/radiotherapies/{radiotherapyId}

Delete Radiotherapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}

Update Radiotherapy

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "69125818-b2ab-4bfc-8393-fbad0b441f10",
    "period": {
        "start": "2022-04-13",
        "end": "2022-04-13"
    },
    "sessions": 0,
    "intent": "curative",
    "terminationReason": null,
    "therapyLineId": "af250317-fa01-4e7b-a6af-53950a0325af",
    "targetedEntitiesIds": [
        "2c7a8b04-74ef-4f14-80d8-47421a06d50a"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who received the radiotherapy",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "period": {
            "$ref": "#/components/schemas/Period",
            "description": "Clinically-relevant period during which the radiotherapy was administered to the patient.",
            "title": "Treatment period"
        },
        "sessions": {
            "description": "The total number of radiotherapy sessions over the treatment period.",
            "title": "Total sessions",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/RadiotherapyIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "terminationReason": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Explanation for the premature or planned termination of the radiotherapy",
            "title": "Termination reason",
            "x-terminology": "TreatmentTerminationReason"
        },
        "therapyLineId": {
            "description": "Therapy line to which the radiotherapy is assigned to",
            "format": "uuid",
            "title": "Therapy line",
            "type": "string"
        },
        "targetedEntitiesIds": {
            "description": "References to the neoplastic entities that were targeted by the radiotherapy",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Targeted neoplastic entities",
            "type": "array"
        }
    },
    "required": [
        "caseId",
        "period",
        "sessions",
        "intent"
    ],
    "title": "RadiotherapyCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "7aed982e-0b6c-4f43-ac62-b26e92d23d18",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/history/events

Get All Radiotherapy History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
radiotherapyId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}

Get Radiotherapy History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
radiotherapyId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}/history/events/{eventId}/reversion

Revert Radiotherapy To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
radiotherapyId path string No

Response 201 Created

{
    "id": "36eafacd-6100-47db-b5f6-9dbe347f975a",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/dosages

Get Radiotherapy Dosages Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Response 200 OK

[
    {
        "id": "635b0a4a-5123-4069-a21e-18c29291e230",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "fractions": 0,
        "dose": null,
        "irradiatedVolume": {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        },
        "irradiatedVolumeMorphology": null,
        "irradiatedVolumeQualifier": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/RadiotherapyDosage"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/radiotherapies/{radiotherapyId}/dosages

Create Radiotherapy Dosage

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "fractions": 0,
    "dose": null,
    "irradiatedVolume": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "irradiatedVolumeMorphology": null,
    "irradiatedVolumeQualifier": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "fractions": {
            "description": "The total number of radiotherapy fractions delivered over the treatment period.",
            "title": "Total fractions",
            "type": "integer"
        },
        "dose": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Total radiation dose delivered over the full radiotherapy course",
            "title": "Total radiation dose",
            "x-default-unit": "Gy",
            "x-measure": "RadiationDose"
        },
        "irradiatedVolume": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the irradiated volume",
            "title": "Irradiated volume",
            "x-terminology": "RadiotherapyTreatmentLocation"
        },
        "irradiatedVolumeMorphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the anatomical location of the irradiated volume",
            "title": "Irradiated volume morphology",
            "x-terminology": "RadiotherapyVolumeType"
        },
        "irradiatedVolumeQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the irradiated volume",
            "title": "Irradiated volume qualifier",
            "x-terminology": "RadiotherapyTreatmentLocationQualifier"
        }
    },
    "required": [
        "irradiatedVolume"
    ],
    "title": "RadiotherapyDosageCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "8b93d8ac-a893-4acf-bfa9-9b176a11a4df",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}

Get Radiotherapy Dosage By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
radiotherapyId path string No

Response 200 OK

{
    "id": "d45ce167-8305-48a6-a815-7abd9e38c5c1",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "fractions": 0,
    "dose": null,
    "irradiatedVolume": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "irradiatedVolumeMorphology": null,
    "irradiatedVolumeQualifier": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "fractions": {
            "description": "The total number of radiotherapy fractions delivered over the treatment period.",
            "title": "Total fractions",
            "type": "integer"
        },
        "dose": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Total radiation dose delivered over the full radiotherapy course",
            "title": "Total radiation dose",
            "x-default-unit": "Gy",
            "x-measure": "RadiationDose"
        },
        "irradiatedVolume": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the irradiated volume",
            "title": "Irradiated volume",
            "x-terminology": "RadiotherapyTreatmentLocation"
        },
        "irradiatedVolumeMorphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the anatomical location of the irradiated volume",
            "title": "Irradiated volume morphology",
            "x-terminology": "RadiotherapyVolumeType"
        },
        "irradiatedVolumeQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the irradiated volume",
            "title": "Irradiated volume qualifier",
            "x-terminology": "RadiotherapyTreatmentLocationQualifier"
        }
    },
    "required": [
        "id",
        "description",
        "irradiatedVolume"
    ],
    "title": "RadiotherapyDosage",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}

Update Radiotherapy Dosage

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
radiotherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "fractions": 0,
    "dose": null,
    "irradiatedVolume": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "irradiatedVolumeMorphology": null,
    "irradiatedVolumeQualifier": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "fractions": {
            "description": "The total number of radiotherapy fractions delivered over the treatment period.",
            "title": "Total fractions",
            "type": "integer"
        },
        "dose": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Total radiation dose delivered over the full radiotherapy course",
            "title": "Total radiation dose",
            "x-default-unit": "Gy",
            "x-measure": "RadiationDose"
        },
        "irradiatedVolume": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Anatomical location of the irradiated volume",
            "title": "Irradiated volume",
            "x-terminology": "RadiotherapyTreatmentLocation"
        },
        "irradiatedVolumeMorphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the anatomical location of the irradiated volume",
            "title": "Irradiated volume morphology",
            "x-terminology": "RadiotherapyVolumeType"
        },
        "irradiatedVolumeQualifier": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "General qualifier for the anatomical location of the irradiated volume",
            "title": "Irradiated volume qualifier",
            "x-terminology": "RadiotherapyTreatmentLocationQualifier"
        }
    },
    "required": [
        "irradiatedVolume"
    ],
    "title": "RadiotherapyDosageCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "af0e8c1d-62e9-4a9d-b9be-0b1a60f4f0d8",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}

Delete Radiotherapy Dosage

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
radiotherapyId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events

Get All Radiotherapy Dosage History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No
radiotherapyId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}

Get Radiotherapy Dosage History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
eventId path string No
radiotherapyId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}/reversion

Revert Radiotherapy Dosage To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
dosageId path string No
eventId path string No
radiotherapyId path string No

Response 201 Created

{
    "id": "8f630333-21b0-424d-8aaa-f333a475283d",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/settings

Get Radiotherapy Settings Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Response 200 OK

[
    {
        "id": "780794d2-a85b-42cb-95d8-58f09a05eaf8",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "modality": {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        },
        "technique": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/RadiotherapySetting"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/radiotherapies/{radiotherapyId}/settings

Create Radiotherapy Setting

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "modality": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "technique": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "modality": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Modality of external beam or brachytherapy radiation procedures",
            "title": "Modality",
            "x-terminology": "RadiotherapyModality"
        },
        "technique": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Technique of external beam or brachytherapy radiation procedures",
            "title": "Technique",
            "x-terminology": "RadiotherapyTechnique"
        }
    },
    "required": [
        "modality",
        "technique"
    ],
    "title": "RadiotherapySettingCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "0b781847-06e8-42e1-afbb-9a0fefbb2aa1",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}

Get Radiotherapy Setting By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No
settingId path string No

Response 200 OK

{
    "id": "93084db4-67b1-4fbf-90d0-f9bb5c5effa2",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "modality": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "technique": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "modality": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Modality of external beam or brachytherapy radiation procedures",
            "title": "Modality",
            "x-terminology": "RadiotherapyModality"
        },
        "technique": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Technique of external beam or brachytherapy radiation procedures",
            "title": "Technique",
            "x-terminology": "RadiotherapyTechnique"
        }
    },
    "required": [
        "id",
        "description",
        "modality",
        "technique"
    ],
    "title": "RadiotherapySetting",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}

Update Radiotherapy Setting

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No
settingId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "modality": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "technique": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "modality": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Modality of external beam or brachytherapy radiation procedures",
            "title": "Modality",
            "x-terminology": "RadiotherapyModality"
        },
        "technique": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Technique of external beam or brachytherapy radiation procedures",
            "title": "Technique",
            "x-terminology": "RadiotherapyTechnique"
        }
    },
    "required": [
        "modality",
        "technique"
    ],
    "title": "RadiotherapySettingCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "3c524297-3901-47d6-ab84-a24d994b9079",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}

Delete Radiotherapy Setting

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
radiotherapyId path string No
settingId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events

Get All Radiotherapy Setting History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
radiotherapyId path string No
settingId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}

Get Radiotherapy Setting History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
radiotherapyId path string No
settingId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/radiotherapies/{radiotherapyId}/settings/{settingId}/history/events/{eventId}/reversion

Revert Radiotherapy Setting To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
radiotherapyId path string No
settingId path string No

Response 201 Created

{
    "id": "5f050c49-38f0-4ffd-b290-185c482809b5",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Therapy Lines


GET /api/v1/therapy-lines

Get All Therapy Lines Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
intent query None No Intent - Filter for single value choice
intent.anyOf query array No Intent - ('Filter for excluding a subset of value choices',)
intent.not query None No Intent - ('Filter for all but a single value choice',)
label query string No Label - Filter for full text matches
label.anyOf query array No Label - Filter for entries where at least one reference matches the query
label.beginsWith query string No Label - Filter for entries starting with the text
label.contains query string No Label - Filter for partial text matches
label.endsWith query string No Label - Filter for entries ending with the text
label.not query string No Label - Filter for full text mismatches
label.not.anyOf query array No Label - Filter for entries where at least one reference mismatches the query
label.not.beginsWith query string No Label - Filter for entries not starting with the text
label.not.contains query string No Label - Filter for partial text mismatches
label.not.endsWith query string No Label - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
ordinal.between query array No Line ordinal number - Filter for entries with values between two specified values (inclusive)
ordinal.equal query integer No Line ordinal number - Filter for entries with values exactly equal to the specified value
ordinal.greaterThan query integer No Line ordinal number - Filter for entries with values greater than the specified value
ordinal.greaterThanOrEqual query integer No Line ordinal number - Filter for entries with values greater than or equal to the specified value
ordinal.lessThan query integer No Line ordinal number - Filter for entries with values less than the specified value
ordinal.lessThanOrEqual query integer No Line ordinal number - Filter for entries with values less than or equal to the specified value
ordinal.not.between query array No Line ordinal number - Filter for entries with values between two specified values (inclusive)
ordinal.not.equal query integer No Line ordinal number - Filter for entries with values not equal to the specified value
period.containedBy query array No Period - Filter for entries whose period are contined by the time period
period.contains query array No Period - Filter for entries containing the time period
period.exists query boolean No Period - Filter for entries with a value
period.not.containedBy query array No Period - Filter for entries whose period are not contined by the time period
period.not.contains query array No Period - Filter for entries not containing the time period
period.not.exists query boolean No Period - Filter for entries without a value
period.not.overlaps query array No Period - Filter for entries not overlapping with the time period
period.overlaps query array No Period - Filter for entries overlapping with the time period
progressionDate.after query string No Begin of progression - Filter for entries with dates after the specified value
progressionDate.before query string No Begin of progression - Filter for entries with dates before the specified value
progressionDate.between query array No Begin of progression - Filter for entries with dates between two specified values (inclusive)
progressionDate.exists query boolean No Begin of progression - Filter for entries with a value
progressionDate.not.between query array No Begin of progression - Filter for entries with dates not between two specified values (inclusive)
progressionDate.not.exists query boolean No Begin of progression - Filter for entries without a value
progressionDate.not.on query string No Begin of progression - Filter for entries with dates not matching the specified value
progressionDate.on query string No Begin of progression - Filter for entries with dates exactly matching the specified value
progressionDate.onOrAfter query string No Begin of progression - Filter for entries with dates on or after the specified value
progressionDate.onOrBefore query string No Begin of progression - Filter for entries with dates on or before the specified value
progressionFreeSurvival.between query array No Progression-free survival in months - Filter for entries with values between two specified values (inclusive)
progressionFreeSurvival.equal query number No Progression-free survival in months - Filter for entries with values exactly equal to the specified value
progressionFreeSurvival.exists query boolean No Progression-free survival in months - Filter for entries with a value
progressionFreeSurvival.greaterThan query number No Progression-free survival in months - Filter for entries with values greater than the specified value
progressionFreeSurvival.greaterThanOrEqual query number No Progression-free survival in months - Filter for entries with values greater than or equal to the specified value
progressionFreeSurvival.lessThan query number No Progression-free survival in months - Filter for entries with values less than the specified value
progressionFreeSurvival.lessThanOrEqual query number No Progression-free survival in months - Filter for entries with values less than or equal to the specified value
progressionFreeSurvival.not.between query array No Progression-free survival in months - Filter for entries with values between two specified values (inclusive)
progressionFreeSurvival.not.equal query number No Progression-free survival in months - Filter for entries with values not equal to the specified value
progressionFreeSurvival.not.exists query boolean No Progression-free survival in months - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "c70988a2-58b5-4a0f-8744-97e57e17a022",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "1fcc3abd-154b-42e9-9f38-6be4a7d62fe1",
            "ordinal": 0,
            "intent": "curative",
            "progressionDate": "2022-04-13",
            "period": null,
            "label": "string",
            "progressionFreeSurvival": 10.12
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/TherapyLine"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[TherapyLine]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/therapy-lines

Create Therapy Line

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "2d025273-2be6-4030-8c9b-c7538e85ee2b",
    "ordinal": 0,
    "intent": "curative",
    "progressionDate": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient to whom this therapy line is associated",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "ordinal": {
            "description": "Number indicating the sequence in which this block of treatments were administered to the patient",
            "title": "Line ordinal number",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/TherapyLineIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "progressionDate": {
            "description": "Date at which progression was first detected, if applicable",
            "format": "date",
            "title": "Begin of progression",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "ordinal",
        "intent"
    ],
    "title": "TherapyLineCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "ae74d9b2-ab63-4ccf-b250-9247c0616049",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/therapy-lines/{therapyLineId}

Get Therapy Line By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
therapyLineId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "afa6c9ba-7b15-4498-a5ec-fa302839556b",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "52cb33c6-c373-434f-9f13-8d473418c58b",
    "ordinal": 0,
    "intent": "curative",
    "progressionDate": "2022-04-13",
    "period": null,
    "label": "string",
    "progressionFreeSurvival": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient to whom this therapy line is associated",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "ordinal": {
            "description": "Number indicating the sequence in which this block of treatments were administered to the patient",
            "title": "Line ordinal number",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/TherapyLineIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "progressionDate": {
            "description": "Date at which progression was first detected, if applicable",
            "format": "date",
            "title": "Begin of progression",
            "type": "string"
        },
        "period": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Period"
                }
            ],
            "description": "Time period of the therapy line",
            "title": "Period"
        },
        "label": {
            "description": "Label categorizing the therapy line",
            "title": "Label",
            "type": "string"
        },
        "progressionFreeSurvival": {
            "description": "Progression-free survival (PFS) of the patient for the therapy line",
            "title": "Progression-free survival in months",
            "type": "number"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "ordinal",
        "intent",
        "label"
    ],
    "title": "TherapyLine",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/therapy-lines/{therapyLineId}

Update Therapy Line

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
therapyLineId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "98de35e0-3cbc-442f-9e0e-df4699b62dd8",
    "ordinal": 0,
    "intent": "curative",
    "progressionDate": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient to whom this therapy line is associated",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "ordinal": {
            "description": "Number indicating the sequence in which this block of treatments were administered to the patient",
            "title": "Line ordinal number",
            "type": "integer"
        },
        "intent": {
            "$ref": "#/components/schemas/TherapyLineIntentChoices",
            "description": "Treatment intent of the system therapy",
            "title": "Intent"
        },
        "progressionDate": {
            "description": "Date at which progression was first detected, if applicable",
            "format": "date",
            "title": "Begin of progression",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "ordinal",
        "intent"
    ],
    "title": "TherapyLineCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "a51a54ed-d9e8-4983-a3a7-e6805dc55c8f",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/therapy-lines/{therapyLineId}

Delete Therapy Line

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
therapyLineId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/therapy-lines/{therapyLineId}/history/events

Get All Therapy Line History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
therapyLineId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}

Get Therapy Line History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
therapyLineId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/therapy-lines/{therapyLineId}/history/events/{eventId}/reversion

Revert Therapy Line To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
therapyLineId path string No

Response 201 Created

{
    "id": "f428ecc3-bcbf-4cd7-800f-571544934a53",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/therapy-lines/{caseId}/re-assignments

Get Reassigned Patient Case Therapy Lines

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
caseId path string No

Response 200 OK

[
    {
        "anonymized": true,
        "id": "191aed98-1c01-42e3-a8b0-84a024aff096",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "caseId": "1e88720a-a12d-43a5-b2d8-9ec16f1cbb41",
        "ordinal": 0,
        "intent": "curative",
        "progressionDate": "2022-04-13",
        "period": null,
        "label": "string",
        "progressionFreeSurvival": 10.12
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/TherapyLine"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Adverse Events


GET /api/v1/adverse-events

Get All Adverse Events Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Event date - Filter for entries with dates after the specified value
date.before query string No Event date - Filter for entries with dates before the specified value
date.between query array No Event date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Event date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Event date - Filter for entries with dates not matching the specified value
date.on query string No Event date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Event date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Event date - Filter for entries with dates on or before the specified value
dateResolved.after query string No Date resolved - Filter for entries with dates after the specified value
dateResolved.before query string No Date resolved - Filter for entries with dates before the specified value
dateResolved.between query array No Date resolved - Filter for entries with dates between two specified values (inclusive)
dateResolved.exists query boolean No Date resolved - Filter for entries with a value
dateResolved.not.between query array No Date resolved - Filter for entries with dates not between two specified values (inclusive)
dateResolved.not.exists query boolean No Date resolved - Filter for entries without a value
dateResolved.not.on query string No Date resolved - Filter for entries with dates not matching the specified value
dateResolved.on query string No Date resolved - Filter for entries with dates exactly matching the specified value
dateResolved.onOrAfter query string No Date resolved - Filter for entries with dates on or after the specified value
dateResolved.onOrBefore query string No Date resolved - Filter for entries with dates on or before the specified value
event query string No Adverse event - Filter for a matching concept code
event.anyOf query array No Adverse event - Filter for a matching set of concept codes
event.descendantsOf query string No Adverse event - Filter for all child concepts of a given concepts code
event.not query string No Adverse event - Filter for a mismatching concept code
event.not.anyOf query array No Adverse event - Filter for a mismmatching set of concept codes
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
grade.between query array No Grade - Filter for entries with values between two specified values (inclusive)
grade.equal query integer No Grade - Filter for entries with values exactly equal to the specified value
grade.greaterThan query integer No Grade - Filter for entries with values greater than the specified value
grade.greaterThanOrEqual query integer No Grade - Filter for entries with values greater than or equal to the specified value
grade.lessThan query integer No Grade - Filter for entries with values less than the specified value
grade.lessThanOrEqual query integer No Grade - Filter for entries with values less than or equal to the specified value
grade.not.between query array No Grade - Filter for entries with values between two specified values (inclusive)
grade.not.equal query integer No Grade - Filter for entries with values not equal to the specified value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
mitigations.adjustment query string No Treatment Adjustment - Filter for a matching concept code
mitigations.adjustment.anyOf query array No Treatment Adjustment - Filter for a matching set of concept codes
mitigations.adjustment.descendantsOf query string No Treatment Adjustment - Filter for all child concepts of a given concepts code
mitigations.adjustment.exists query boolean No Treatment Adjustment - Filter for entries with a value
mitigations.adjustment.not query string No Treatment Adjustment - Filter for a mismatching concept code
mitigations.adjustment.not.anyOf query array No Treatment Adjustment - Filter for a mismmatching set of concept codes
mitigations.adjustment.not.exists query boolean No Treatment Adjustment - Filter for entries without a value
mitigations.category query None No Mitigation category - Filter for single value choice
mitigations.category.anyOf query array No Mitigation category - ('Filter for excluding a subset of value choices',)
mitigations.category.not query None No Mitigation category - ('Filter for all but a single value choice',)
mitigations.createdAt.after query string No Created at - Filter for entries with dates after the specified value
mitigations.createdAt.before query string No Created at - Filter for entries with dates before the specified value
mitigations.createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
mitigations.createdAt.exists query boolean No Created at - Filter for entries with a value
mitigations.createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
mitigations.createdAt.not.exists query boolean No Created at - Filter for entries without a value
mitigations.createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
mitigations.createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
mitigations.createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
mitigations.createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
mitigations.drug query string No Pharmacological drug - Filter for a matching concept code
mitigations.drug.anyOf query array No Pharmacological drug - Filter for a matching set of concept codes
mitigations.drug.descendantsOf query string No Pharmacological drug - Filter for all child concepts of a given concepts code
mitigations.drug.exists query boolean No Pharmacological drug - Filter for entries with a value
mitigations.drug.not query string No Pharmacological drug - Filter for a mismatching concept code
mitigations.drug.not.anyOf query array No Pharmacological drug - Filter for a mismmatching set of concept codes
mitigations.drug.not.exists query boolean No Pharmacological drug - Filter for entries without a value
mitigations.externalSource query string No External data source - Filter for full text matches
mitigations.externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
mitigations.externalSource.beginsWith query string No External data source - Filter for entries starting with the text
mitigations.externalSource.contains query string No External data source - Filter for partial text matches
mitigations.externalSource.endsWith query string No External data source - Filter for entries ending with the text
mitigations.externalSource.exists query boolean No External data source - Filter for entries with a value
mitigations.externalSource.not query string No External data source - Filter for full text mismatches
mitigations.externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
mitigations.externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
mitigations.externalSource.not.contains query string No External data source - Filter for partial text mismatches
mitigations.externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
mitigations.externalSource.not.exists query boolean No External data source - Filter for entries without a value
mitigations.id query string No Id - Filter for full text matches
mitigations.id.anyOf query array No Id - Filter for entries where at least one reference matches the query
mitigations.id.beginsWith query string No Id - Filter for entries starting with the text
mitigations.id.contains query string No Id - Filter for partial text matches
mitigations.id.endsWith query string No Id - Filter for entries ending with the text
mitigations.id.not query string No Id - Filter for full text mismatches
mitigations.id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
mitigations.id.not.beginsWith query string No Id - Filter for entries not starting with the text
mitigations.id.not.contains query string No Id - Filter for partial text mismatches
mitigations.id.not.endsWith query string No Id - Filter for entries not ending with the text
mitigations.management query string No Management - Filter for a matching concept code
mitigations.management.anyOf query array No Management - Filter for a matching set of concept codes
mitigations.management.descendantsOf query string No Management - Filter for all child concepts of a given concepts code
mitigations.management.exists query boolean No Management - Filter for entries with a value
mitigations.management.not query string No Management - Filter for a mismatching concept code
mitigations.management.not.anyOf query array No Management - Filter for a mismmatching set of concept codes
mitigations.management.not.exists query boolean No Management - Filter for entries without a value
mitigations.procedure query string No Procedure - Filter for a matching concept code
mitigations.procedure.anyOf query array No Procedure - Filter for a matching set of concept codes
mitigations.procedure.descendantsOf query string No Procedure - Filter for all child concepts of a given concepts code
mitigations.procedure.exists query boolean No Procedure - Filter for entries with a value
mitigations.procedure.not query string No Procedure - Filter for a mismatching concept code
mitigations.procedure.not.anyOf query array No Procedure - Filter for a mismmatching set of concept codes
mitigations.procedure.not.exists query boolean No Procedure - Filter for entries without a value
mitigations.updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
mitigations.updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
mitigations.updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
mitigations.updatedAt.exists query boolean No Updated at - Filter for entries with a value
mitigations.updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
mitigations.updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
mitigations.updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
mitigations.updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
mitigations.updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
mitigations.updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
offset query integer 0 No
ordering query None No
outcome query None No Date resolved - Filter for single value choice
outcome.anyOf query array No Date resolved - ('Filter for excluding a subset of value choices',)
outcome.not query None No Date resolved - ('Filter for all but a single value choice',)
suspectedCauses.causality query None No Causality - Filter for single value choice
suspectedCauses.causality.anyOf query array No Causality - ('Filter for excluding a subset of value choices',)
suspectedCauses.causality.exists query boolean No Causality - Filter for entries with a value
suspectedCauses.causality.not query None No Causality - ('Filter for all but a single value choice',)
suspectedCauses.causality.not.exists query boolean No Causality - Filter for entries without a value
suspectedCauses.createdAt.after query string No Created at - Filter for entries with dates after the specified value
suspectedCauses.createdAt.before query string No Created at - Filter for entries with dates before the specified value
suspectedCauses.createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
suspectedCauses.createdAt.exists query boolean No Created at - Filter for entries with a value
suspectedCauses.createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
suspectedCauses.createdAt.not.exists query boolean No Created at - Filter for entries without a value
suspectedCauses.createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
suspectedCauses.createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
suspectedCauses.createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
suspectedCauses.createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
suspectedCauses.externalSource query string No External data source - Filter for full text matches
suspectedCauses.externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
suspectedCauses.externalSource.beginsWith query string No External data source - Filter for entries starting with the text
suspectedCauses.externalSource.contains query string No External data source - Filter for partial text matches
suspectedCauses.externalSource.endsWith query string No External data source - Filter for entries ending with the text
suspectedCauses.externalSource.exists query boolean No External data source - Filter for entries with a value
suspectedCauses.externalSource.not query string No External data source - Filter for full text mismatches
suspectedCauses.externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
suspectedCauses.externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
suspectedCauses.externalSource.not.contains query string No External data source - Filter for partial text mismatches
suspectedCauses.externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
suspectedCauses.externalSource.not.exists query boolean No External data source - Filter for entries without a value
suspectedCauses.id query string No Id - Filter for full text matches
suspectedCauses.id.anyOf query array No Id - Filter for entries where at least one reference matches the query
suspectedCauses.id.beginsWith query string No Id - Filter for entries starting with the text
suspectedCauses.id.contains query string No Id - Filter for partial text matches
suspectedCauses.id.endsWith query string No Id - Filter for entries ending with the text
suspectedCauses.id.not query string No Id - Filter for full text mismatches
suspectedCauses.id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
suspectedCauses.id.not.beginsWith query string No Id - Filter for entries not starting with the text
suspectedCauses.id.not.contains query string No Id - Filter for partial text mismatches
suspectedCauses.id.not.endsWith query string No Id - Filter for entries not ending with the text
suspectedCauses.medicationId query string No Suspected systemic therapy medication - Filter for reference matches
suspectedCauses.medicationId.anyOf query array No Suspected systemic therapy medication - Filter for entries where at least one reference matches the query
suspectedCauses.medicationId.beginsWith query string No Suspected systemic therapy medication - Filter for entries starting with the text
suspectedCauses.medicationId.contains query string No Suspected systemic therapy medication - Filter for partial text matches
suspectedCauses.medicationId.endsWith query string No Suspected systemic therapy medication - Filter for entries ending with the text
suspectedCauses.medicationId.exists query boolean No Suspected systemic therapy medication - Filter for entries with a value
suspectedCauses.medicationId.not query string No Suspected systemic therapy medication - Filter for reference mismatches
suspectedCauses.medicationId.not.anyOf query array No Suspected systemic therapy medication - Filter for entries where at least one reference mismatches the query
suspectedCauses.medicationId.not.beginsWith query string No Suspected systemic therapy medication - Filter for entries not starting with the text
suspectedCauses.medicationId.not.contains query string No Suspected systemic therapy medication - Filter for partial text mismatches
suspectedCauses.medicationId.not.endsWith query string No Suspected systemic therapy medication - Filter for entries not ending with the text
suspectedCauses.medicationId.not.exists query boolean No Suspected systemic therapy medication - Filter for entries without a value
suspectedCauses.radiotherapyId query string No Suspected radiotherapy - Filter for reference matches
suspectedCauses.radiotherapyId.anyOf query array No Suspected radiotherapy - Filter for entries where at least one reference matches the query
suspectedCauses.radiotherapyId.beginsWith query string No Suspected radiotherapy - Filter for entries starting with the text
suspectedCauses.radiotherapyId.contains query string No Suspected radiotherapy - Filter for partial text matches
suspectedCauses.radiotherapyId.endsWith query string No Suspected radiotherapy - Filter for entries ending with the text
suspectedCauses.radiotherapyId.exists query boolean No Suspected radiotherapy - Filter for entries with a value
suspectedCauses.radiotherapyId.not query string No Suspected radiotherapy - Filter for reference mismatches
suspectedCauses.radiotherapyId.not.anyOf query array No Suspected radiotherapy - Filter for entries where at least one reference mismatches the query
suspectedCauses.radiotherapyId.not.beginsWith query string No Suspected radiotherapy - Filter for entries not starting with the text
suspectedCauses.radiotherapyId.not.contains query string No Suspected radiotherapy - Filter for partial text mismatches
suspectedCauses.radiotherapyId.not.endsWith query string No Suspected radiotherapy - Filter for entries not ending with the text
suspectedCauses.radiotherapyId.not.exists query boolean No Suspected radiotherapy - Filter for entries without a value
suspectedCauses.surgeryId query string No Suspected surgery - Filter for reference matches
suspectedCauses.surgeryId.anyOf query array No Suspected surgery - Filter for entries where at least one reference matches the query
suspectedCauses.surgeryId.beginsWith query string No Suspected surgery - Filter for entries starting with the text
suspectedCauses.surgeryId.contains query string No Suspected surgery - Filter for partial text matches
suspectedCauses.surgeryId.endsWith query string No Suspected surgery - Filter for entries ending with the text
suspectedCauses.surgeryId.exists query boolean No Suspected surgery - Filter for entries with a value
suspectedCauses.surgeryId.not query string No Suspected surgery - Filter for reference mismatches
suspectedCauses.surgeryId.not.anyOf query array No Suspected surgery - Filter for entries where at least one reference mismatches the query
suspectedCauses.surgeryId.not.beginsWith query string No Suspected surgery - Filter for entries not starting with the text
suspectedCauses.surgeryId.not.contains query string No Suspected surgery - Filter for partial text mismatches
suspectedCauses.surgeryId.not.endsWith query string No Suspected surgery - Filter for entries not ending with the text
suspectedCauses.surgeryId.not.exists query boolean No Suspected surgery - Filter for entries without a value
suspectedCauses.systemicTherapyId query string No Suspected systemic therapy - Filter for reference matches
suspectedCauses.systemicTherapyId.anyOf query array No Suspected systemic therapy - Filter for entries where at least one reference matches the query
suspectedCauses.systemicTherapyId.beginsWith query string No Suspected systemic therapy - Filter for entries starting with the text
suspectedCauses.systemicTherapyId.contains query string No Suspected systemic therapy - Filter for partial text matches
suspectedCauses.systemicTherapyId.endsWith query string No Suspected systemic therapy - Filter for entries ending with the text
suspectedCauses.systemicTherapyId.exists query boolean No Suspected systemic therapy - Filter for entries with a value
suspectedCauses.systemicTherapyId.not query string No Suspected systemic therapy - Filter for reference mismatches
suspectedCauses.systemicTherapyId.not.anyOf query array No Suspected systemic therapy - Filter for entries where at least one reference mismatches the query
suspectedCauses.systemicTherapyId.not.beginsWith query string No Suspected systemic therapy - Filter for entries not starting with the text
suspectedCauses.systemicTherapyId.not.contains query string No Suspected systemic therapy - Filter for partial text mismatches
suspectedCauses.systemicTherapyId.not.endsWith query string No Suspected systemic therapy - Filter for entries not ending with the text
suspectedCauses.systemicTherapyId.not.exists query boolean No Suspected systemic therapy - Filter for entries without a value
suspectedCauses.updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
suspectedCauses.updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
suspectedCauses.updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
suspectedCauses.updatedAt.exists query boolean No Updated at - Filter for entries with a value
suspectedCauses.updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
suspectedCauses.updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
suspectedCauses.updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
suspectedCauses.updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
suspectedCauses.updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
suspectedCauses.updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "c478fc8b-4f8a-4354-a85b-37aab47495ca",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "ae4f2db6-fa9d-4d27-9b9b-ef92a7e365be",
            "date": "2022-04-13",
            "event": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "grade": 0,
            "outcome": "resolved",
            "dateResolved": "2022-04-13",
            "suspectedCauses": [
                {
                    "id": "c5c6b3bb-b04d-4ab3-9f62-2dd2abce839a",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "systemicTherapyId": "3169e216-4be9-48ec-8b9e-1068e461401f",
                    "medicationId": "dd99be46-ec84-49de-a757-8686038c14c7",
                    "radiotherapyId": "d1d12633-26c0-4b25-804e-ffabc7414e23",
                    "surgeryId": "a60f878d-071b-464a-8781-2656d62e0c78",
                    "causality": null
                }
            ],
            "mitigations": [
                {
                    "id": "ad1470d9-48e5-4ad7-bb58-55d307f4c7aa",
                    "description": "string",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "category": "adjustment",
                    "adjustment": null,
                    "drug": null,
                    "procedure": null,
                    "management": null
                }
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/AdverseEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[AdverseEvent]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/adverse-events

Create Adverse Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "50ca7951-5cec-452e-99df-a4f942621082",
    "date": "2022-04-13",
    "event": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "grade": 0,
    "outcome": "resolved",
    "dateResolved": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who had the adverse event being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the adverse event ocurred.",
            "format": "date",
            "title": "Event date",
            "type": "string"
        },
        "event": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Classification of the adverse event using CTCAE criteria",
            "title": "Adverse event",
            "x-terminology": "AdverseEventTerm"
        },
        "grade": {
            "description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
            "title": "Grade",
            "type": "integer"
        },
        "outcome": {
            "$ref": "#/components/schemas/AdverseEventOutcomeChoices",
            "description": "The date when the adverse event ended or returned to baseline.",
            "title": "Date resolved"
        },
        "dateResolved": {
            "description": "The date when the adverse event ended or returned to baseline.",
            "format": "date",
            "title": "Date resolved",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "date",
        "event",
        "grade",
        "outcome"
    ],
    "title": "AdverseEventCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "81993912-fb18-4dd3-8bbd-12e344800e9a",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}

Get Adverse Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)

Response 200 OK

{
    "anonymized": true,
    "id": "944518a0-4ae4-4a2c-8fc3-dc051faa8d57",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "84bdd7be-3672-48a7-a56a-739ee22d64d0",
    "date": "2022-04-13",
    "event": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "grade": 0,
    "outcome": "resolved",
    "dateResolved": "2022-04-13",
    "suspectedCauses": [
        {
            "id": "905eb208-cfe1-459e-9daa-9cd42ddfe17b",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "systemicTherapyId": "1b0cbf96-01c2-44f7-871c-36b5547691a9",
            "medicationId": "d2308e70-3114-48f7-a4ed-8fe92843b1f8",
            "radiotherapyId": "b5c763fd-f9fe-40f1-94d2-e834b461dd9f",
            "surgeryId": "43dffaa6-a8a3-4d15-8900-dba54b6974be",
            "causality": null
        }
    ],
    "mitigations": [
        {
            "id": "7b4f5884-48db-4fbf-ae5b-97f1449b56a9",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "category": "adjustment",
            "adjustment": null,
            "drug": null,
            "procedure": null,
            "management": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who had the adverse event being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the adverse event ocurred.",
            "format": "date",
            "title": "Event date",
            "type": "string"
        },
        "event": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Classification of the adverse event using CTCAE criteria",
            "title": "Adverse event",
            "x-terminology": "AdverseEventTerm"
        },
        "grade": {
            "description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
            "title": "Grade",
            "type": "integer"
        },
        "outcome": {
            "$ref": "#/components/schemas/AdverseEventOutcomeChoices",
            "description": "The date when the adverse event ended or returned to baseline.",
            "title": "Date resolved"
        },
        "dateResolved": {
            "description": "The date when the adverse event ended or returned to baseline.",
            "format": "date",
            "title": "Date resolved",
            "type": "string"
        },
        "suspectedCauses": {
            "description": "Suspected causes of the adverse event",
            "items": {
                "$ref": "#/components/schemas/AdverseEventSuspectedCause"
            },
            "title": "Suspected causes",
            "type": "array"
        },
        "mitigations": {
            "description": "Mitigations of the adverse event",
            "items": {
                "$ref": "#/components/schemas/AdverseEventMitigation"
            },
            "title": "Mitigations",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "event",
        "grade",
        "outcome",
        "suspectedCauses",
        "mitigations"
    ],
    "title": "AdverseEvent",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/adverse-events/{adverseEventId}

Delete Adverse Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}

Update Adverse Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "ce3aa779-7e5b-4f15-8399-3d993e31ea9b",
    "date": "2022-04-13",
    "event": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "grade": 0,
    "outcome": "resolved",
    "dateResolved": "2022-04-13"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who had the adverse event being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the adverse event ocurred.",
            "format": "date",
            "title": "Event date",
            "type": "string"
        },
        "event": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Classification of the adverse event using CTCAE criteria",
            "title": "Adverse event",
            "x-terminology": "AdverseEventTerm"
        },
        "grade": {
            "description": "The grade associated with the severity of an adverse event, using CTCAE criteria.",
            "title": "Grade",
            "type": "integer"
        },
        "outcome": {
            "$ref": "#/components/schemas/AdverseEventOutcomeChoices",
            "description": "The date when the adverse event ended or returned to baseline.",
            "title": "Date resolved"
        },
        "dateResolved": {
            "description": "The date when the adverse event ended or returned to baseline.",
            "format": "date",
            "title": "Date resolved",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "date",
        "event",
        "grade",
        "outcome"
    ],
    "title": "AdverseEventCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "6f8326c6-0ab8-450b-bc52-44df91d03eac",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/history/events

Get All Adverse Event History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}

Get Adverse Event History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}/history/events/{eventId}/reversion

Revert Adverse Event To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
eventId path string No

Response 201 Created

{
    "id": "f2151528-c266-4902-b0c6-ba8bc5a78b54",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/suspected-causes

Get Adverse Event Suspected Causes Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Response 200 OK

[
    {
        "id": "7f947220-a1ec-4543-b317-ddee3ee3dfe4",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "systemicTherapyId": "020d210e-f75d-4063-82e2-b49d8339e80c",
        "medicationId": "2fb03ef5-80a0-4a1c-9371-0652a8a43709",
        "radiotherapyId": "3000cfc3-3488-40ca-9383-aeb6368de841",
        "surgeryId": "19521a24-31d6-4c09-84ca-f11a3be44631",
        "causality": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/AdverseEventSuspectedCause"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/adverse-events/{adverseEventId}/suspected-causes

Create Adverse Event Suspected Cause

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "systemicTherapyId": "fc92ee99-7553-4938-b6fc-e4e31446d29c",
    "medicationId": "eb204076-8d76-4b38-a2a2-2ce3f12076e6",
    "radiotherapyId": "bcaf9ccb-0f6a-445a-bf61-e844f039f2ef",
    "surgeryId": "3a774158-914c-407f-9c40-0039ecb0ff61",
    "causality": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "systemicTherapyId": {
            "description": "Systemic therapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy",
            "type": "string"
        },
        "medicationId": {
            "description": "Systemic therapy medication suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy medication",
            "type": "string"
        },
        "radiotherapyId": {
            "description": "Radiotherapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected radiotherapy",
            "type": "string"
        },
        "surgeryId": {
            "description": "Surgery suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected surgery",
            "type": "string"
        },
        "causality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
                }
            ],
            "description": "Assessment of the potential causality",
            "title": "Causality"
        }
    },
    "title": "AdverseEventSuspectedCauseCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "07e0b432-a6f8-4e65-8365-ea3a03569dd6",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}

Get Adverse Event Suspected Cause By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No

Response 200 OK

{
    "id": "9f043edb-8137-4c6c-8c6e-077b3a1d7a8c",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "systemicTherapyId": "a67b941d-c6f0-40a0-b712-7478d75da4ce",
    "medicationId": "6d4a7c67-5151-4460-aeda-82665b09d494",
    "radiotherapyId": "4469db45-54bc-4c03-b867-b8df0b1c25a4",
    "surgeryId": "ba4f1b2e-66d6-48de-b3d0-c4b5c5e64b05",
    "causality": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "systemicTherapyId": {
            "description": "Systemic therapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy",
            "type": "string"
        },
        "medicationId": {
            "description": "Systemic therapy medication suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy medication",
            "type": "string"
        },
        "radiotherapyId": {
            "description": "Radiotherapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected radiotherapy",
            "type": "string"
        },
        "surgeryId": {
            "description": "Surgery suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected surgery",
            "type": "string"
        },
        "causality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
                }
            ],
            "description": "Assessment of the potential causality",
            "title": "Causality"
        }
    },
    "required": [
        "id",
        "description"
    ],
    "title": "AdverseEventSuspectedCause",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}

Update Adverse Event Suspected Cause

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "systemicTherapyId": "9e12c703-4849-4510-bc17-96f4cd9b88b8",
    "medicationId": "b7eaea26-56a3-4c83-befc-4237c098920c",
    "radiotherapyId": "00fdecd4-0c71-4267-b0a0-f48bb2412c18",
    "surgeryId": "da1813b2-1c62-4a24-8c9e-73c5c4d0435c",
    "causality": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "systemicTherapyId": {
            "description": "Systemic therapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy",
            "type": "string"
        },
        "medicationId": {
            "description": "Systemic therapy medication suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected systemic therapy medication",
            "type": "string"
        },
        "radiotherapyId": {
            "description": "Radiotherapy suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected radiotherapy",
            "type": "string"
        },
        "surgeryId": {
            "description": "Surgery suspected to be the cause of the adverse event",
            "format": "uuid",
            "title": "Suspected surgery",
            "type": "string"
        },
        "causality": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AdverseEventSuspectedCauseCausalityChoices"
                }
            ],
            "description": "Assessment of the potential causality",
            "title": "Causality"
        }
    },
    "title": "AdverseEventSuspectedCauseCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "e29df6f6-4f86-462d-974f-865108bfe6ea",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}

Delete Adverse Event Suspected Cause

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events

Get All Adverse Event Suspected Cause History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}

Get Adverse Event Suspected Cause History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}/suspected-causes/{causeId}/history/events/{eventId}/reversion

Revert Adverse Event Suspected Cause To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
causeId path string No
eventId path string No

Response 201 Created

{
    "id": "5583e20a-feec-4c3a-87c4-73270a641ceb",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/mitigations

Get Adverse Event Mitigations Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Response 200 OK

[
    {
        "id": "d81be880-0d51-44e5-9f4b-95b8e08e7441",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "category": "adjustment",
        "adjustment": null,
        "drug": null,
        "procedure": null,
        "management": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/AdverseEventMitigation"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/adverse-events/{adverseEventId}/mitigations

Create Adverse Event Mitigation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "category": "adjustment",
    "adjustment": null,
    "drug": null,
    "procedure": null,
    "management": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "category": {
            "$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
            "description": "Type of mitigation employed",
            "title": "Mitigation category"
        },
        "adjustment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
            "title": "Treatment Adjustment",
            "x-terminology": "AdverseEventMitigationTreatmentAdjustment"
        },
        "drug": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
            "title": "Pharmacological drug",
            "x-terminology": "AdverseEventMitigationDrug"
        },
        "procedure": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
            "title": "Procedure",
            "x-terminology": "AdverseEventMitigationProcedure"
        },
        "management": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Management type of the adverse event mitigation",
            "title": "Management",
            "x-terminology": "AdverseEventMitigationManagement"
        }
    },
    "required": [
        "category"
    ],
    "title": "AdverseEventMitigationCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "78b99269-44f7-4a53-b0bc-72c0884f0d5b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}

Get Adverse Event Mitigation By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
mitigationId path string No

Response 200 OK

{
    "id": "f9a32930-9e70-4861-92cb-93a48fc377d7",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "category": "adjustment",
    "adjustment": null,
    "drug": null,
    "procedure": null,
    "management": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "category": {
            "$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
            "description": "Type of mitigation employed",
            "title": "Mitigation category"
        },
        "adjustment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
            "title": "Treatment Adjustment",
            "x-terminology": "AdverseEventMitigationTreatmentAdjustment"
        },
        "drug": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
            "title": "Pharmacological drug",
            "x-terminology": "AdverseEventMitigationDrug"
        },
        "procedure": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
            "title": "Procedure",
            "x-terminology": "AdverseEventMitigationProcedure"
        },
        "management": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Management type of the adverse event mitigation",
            "title": "Management",
            "x-terminology": "AdverseEventMitigationManagement"
        }
    },
    "required": [
        "id",
        "description",
        "category"
    ],
    "title": "AdverseEventMitigation",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}

Update Adverse Event Mitigation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
mitigationId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "category": "adjustment",
    "adjustment": null,
    "drug": null,
    "procedure": null,
    "management": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "category": {
            "$ref": "#/components/schemas/AdverseEventMitigationCategoryChoices",
            "description": "Type of mitigation employed",
            "title": "Mitigation category"
        },
        "adjustment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the adjustment of systemic anti-cancer treatment used to mitigate the adverse event (if applicable)",
            "title": "Treatment Adjustment",
            "x-terminology": "AdverseEventMitigationTreatmentAdjustment"
        },
        "drug": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the pharmacological treatment used to mitigate the adverse event (if applicable)",
            "title": "Pharmacological drug",
            "x-terminology": "AdverseEventMitigationDrug"
        },
        "procedure": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the non-pharmacological procedure used to mitigate the adverse event (if applicable)",
            "title": "Procedure",
            "x-terminology": "AdverseEventMitigationProcedure"
        },
        "management": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Management type of the adverse event mitigation",
            "title": "Management",
            "x-terminology": "AdverseEventMitigationManagement"
        }
    },
    "required": [
        "category"
    ],
    "title": "AdverseEventMitigationCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "373fec7c-a092-44b8-99f2-b6ad4c57cbb6",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}

Delete Adverse Event Mitigation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
mitigationId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events

Get All Adverse Event Mitigation History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
limit query integer 10 No
mitigationId path string No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}

Get Adverse Event Mitigation History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
eventId path string No
mitigationId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/adverse-events/{adverseEventId}/mitigations/{mitigationId}/history/events/{eventId}/reversion

Revert Adverse Event Mitigation To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
adverseEventId path string No
eventId path string No
mitigationId path string No

Response 201 Created

{
    "id": "450c7058-f9b9-4c65-8a7f-8f34aa6809ee",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Treatment Responses


GET /api/v1/treatment-responses

Get All Treatment Responses Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
assessedBodysites query string No Assessed anatomical location - Filter for a matching concept code
assessedBodysites.allOf query array No Assessed anatomical location - Filter for entries matching all of the concepts
assessedBodysites.anyOf query array No Assessed anatomical location - Filter for a matching set of concept codes
assessedBodysites.descendantsOf query string No Assessed anatomical location - Filter for all child concepts of a given concepts code
assessedBodysites.exists query boolean No Assessed anatomical location - Filter for entries with a value
assessedBodysites.not query string No Assessed anatomical location - Filter for a mismatching concept code
assessedBodysites.not.allOf query array No Assessed anatomical location - Filter for entries mismatching all of the concepts
assessedBodysites.not.anyOf query array No Assessed anatomical location - Filter for a mismmatching set of concept codes
assessedBodysites.not.exists query boolean No Assessed anatomical location - Filter for entries without a value
assessedEntitiesIds query string No Assessed neoplastic entities - Filter for full text matches
assessedEntitiesIds.anyOf query array No Assessed neoplastic entities - Filter for entries where at least one reference matches the query
assessedEntitiesIds.beginsWith query string No Assessed neoplastic entities - Filter for entries starting with the text
assessedEntitiesIds.contains query string No Assessed neoplastic entities - Filter for partial text matches
assessedEntitiesIds.endsWith query string No Assessed neoplastic entities - Filter for entries ending with the text
assessedEntitiesIds.exists query boolean No Assessed neoplastic entities - Filter for entries with a value
assessedEntitiesIds.not query string No Assessed neoplastic entities - Filter for full text mismatches
assessedEntitiesIds.not.anyOf query array No Assessed neoplastic entities - Filter for entries where at least one reference mismatches the query
assessedEntitiesIds.not.beginsWith query string No Assessed neoplastic entities - Filter for entries not starting with the text
assessedEntitiesIds.not.contains query string No Assessed neoplastic entities - Filter for partial text mismatches
assessedEntitiesIds.not.endsWith query string No Assessed neoplastic entities - Filter for entries not ending with the text
assessedEntitiesIds.not.exists query boolean No Assessed neoplastic entities - Filter for entries without a value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
methodology query string No Assessment method - Filter for a matching concept code
methodology.anyOf query array No Assessment method - Filter for a matching set of concept codes
methodology.descendantsOf query string No Assessment method - Filter for all child concepts of a given concepts code
methodology.not query string No Assessment method - Filter for a mismatching concept code
methodology.not.anyOf query array No Assessment method - Filter for a mismmatching set of concept codes
offset query integer 0 No
ordering query None No
recist query string No RECIST - Filter for a matching concept code
recist.anyOf query array No RECIST - Filter for a matching set of concept codes
recist.descendantsOf query string No RECIST - Filter for all child concepts of a given concepts code
recist.not query string No RECIST - Filter for a mismatching concept code
recist.not.anyOf query array No RECIST - Filter for a mismmatching set of concept codes
recistInterpreted query boolean No RECIST Interpreted? - Filter for yes/no statement
recistInterpreted.exists query boolean No RECIST Interpreted? - Filter for entries with a value
recistInterpreted.not.exists query boolean No RECIST Interpreted? - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "84c1eea6-2de8-4096-820d-227c0a201782",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "83f79287-aad0-484a-bbb4-b9b03a3db9dc",
            "date": "2022-04-13",
            "recist": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "recistInterpreted": true,
            "methodology": null,
            "assessedEntitiesIds": [
                "2ac49962-5cc8-4f6e-8eb4-c4217e1783f4"
            ],
            "assessedBodysites": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/TreatmentResponse"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[TreatmentResponse]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/treatment-responses

Create Treatment Response

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "14256c9d-33ea-4d8c-a34e-31f7631556e2",
    "date": "2022-04-13",
    "recist": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "recistInterpreted": true,
    "methodology": null,
    "assessedEntitiesIds": [
        "72bc1aa0-8290-4687-bafa-60f37c48f574"
    ],
    "assessedBodysites": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's treatment response is asseessed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the treatment response assessment",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "recist": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The classification of the treatment response according to RECIST",
            "title": "RECIST",
            "x-terminology": "CancerTreatmentResponse"
        },
        "recistInterpreted": {
            "description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
            "title": "RECIST Interpreted?",
            "type": "boolean"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Method used to assess and classify the treatment response",
            "title": "Assessment method",
            "x-terminology": "CancerTreatmentResponseObservationMethod"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assesed for treatment response",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        },
        "assessedBodysites": {
            "description": "Anatomical location assessed to determine the treatment response",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Assessed anatomical location",
            "type": "array",
            "x-terminology": "ObservationBodySite"
        }
    },
    "required": [
        "caseId",
        "date",
        "recist",
        "methodology"
    ],
    "title": "TreatmentResponseCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "d5c3314d-7c4e-4c9c-8ea4-ece4b5a84970",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/treatment-responses/{treatmentRresponseId}

Get Treatment Response By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
treatmentRresponseId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "4110b8fa-b26e-42e9-8008-33c28f771e5e",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "c20f9015-042d-4cfb-8a84-0adff625974c",
    "date": "2022-04-13",
    "recist": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "recistInterpreted": true,
    "methodology": null,
    "assessedEntitiesIds": [
        "ce5838aa-2747-4759-9b02-8e9e338c15b3"
    ],
    "assessedBodysites": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's treatment response is asseessed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the treatment response assessment",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "recist": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The classification of the treatment response according to RECIST",
            "title": "RECIST",
            "x-terminology": "CancerTreatmentResponse"
        },
        "recistInterpreted": {
            "description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
            "title": "RECIST Interpreted?",
            "type": "boolean"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Method used to assess and classify the treatment response",
            "title": "Assessment method",
            "x-terminology": "CancerTreatmentResponseObservationMethod"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assesed for treatment response",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        },
        "assessedBodysites": {
            "description": "Anatomical location assessed to determine the treatment response",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Assessed anatomical location",
            "type": "array",
            "x-terminology": "ObservationBodySite"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "recist",
        "methodology"
    ],
    "title": "TreatmentResponse",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/treatment-responses/{treatmentRresponseId}

Update Treatment Response

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
treatmentRresponseId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "ceed9c35-e580-491d-b300-5eefde2eefdf",
    "date": "2022-04-13",
    "recist": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "recistInterpreted": true,
    "methodology": null,
    "assessedEntitiesIds": [
        "a32ec591-2cbe-452c-a856-e6d2b9df33f1"
    ],
    "assessedBodysites": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's treatment response is asseessed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the treatment response assessment",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "recist": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "The classification of the treatment response according to RECIST",
            "title": "RECIST",
            "x-terminology": "CancerTreatmentResponse"
        },
        "recistInterpreted": {
            "description": "Indicates whether the RECIST value was interpreted or taken from the radiology report",
            "title": "RECIST Interpreted?",
            "type": "boolean"
        },
        "methodology": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Method used to assess and classify the treatment response",
            "title": "Assessment method",
            "x-terminology": "CancerTreatmentResponseObservationMethod"
        },
        "assessedEntitiesIds": {
            "description": "References to the neoplastic entities that were assesed for treatment response",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Assessed neoplastic entities",
            "type": "array"
        },
        "assessedBodysites": {
            "description": "Anatomical location assessed to determine the treatment response",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Assessed anatomical location",
            "type": "array",
            "x-terminology": "ObservationBodySite"
        }
    },
    "required": [
        "caseId",
        "date",
        "recist",
        "methodology"
    ],
    "title": "TreatmentResponseCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "efb0bd8c-3cdd-4006-ab68-db9e18dd7cdb",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/treatment-responses/{treatmentRresponseId}

Delete Treatment Response

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
treatmentRresponseId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events

Get All Treatment Response History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
treatmentRresponseId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}

Get Treatment Response History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
treatmentRresponseId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/treatment-responses/{treatmentRresponseId}/history/events/{eventId}/reversion

Revert Treatment Response To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
treatmentRresponseId path string No

Response 201 Created

{
    "id": "fe117760-da34-47a5-abd8-15fcc8911479",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Tumor Boards


GET /api/v1/tumor-boards

Get All Tumor Boards Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Date - Filter for entries with dates after the specified value
date.before query string No Date - Filter for entries with dates before the specified value
date.between query array No Date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Date - Filter for entries with dates not matching the specified value
date.on query string No Date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
recommendations query string No Recommendations - Filter for a matching concept code
recommendations.allOf query array No Recommendations - Filter for entries matching all of the concepts
recommendations.anyOf query array No Recommendations - Filter for a matching set of concept codes
recommendations.descendantsOf query string No Recommendations - Filter for all child concepts of a given concepts code
recommendations.exists query boolean No Recommendations - Filter for entries with a value
recommendations.not query string No Recommendations - Filter for a mismatching concept code
recommendations.not.allOf query array No Recommendations - Filter for entries mismatching all of the concepts
recommendations.not.anyOf query array No Recommendations - Filter for a mismmatching set of concept codes
recommendations.not.exists query boolean No Recommendations - Filter for entries without a value
relatedEntitiesIds query string No Related neoplastic entities - Filter for full text matches
relatedEntitiesIds.anyOf query array No Related neoplastic entities - Filter for entries where at least one reference matches the query
relatedEntitiesIds.beginsWith query string No Related neoplastic entities - Filter for entries starting with the text
relatedEntitiesIds.contains query string No Related neoplastic entities - Filter for partial text matches
relatedEntitiesIds.endsWith query string No Related neoplastic entities - Filter for entries ending with the text
relatedEntitiesIds.exists query boolean No Related neoplastic entities - Filter for entries with a value
relatedEntitiesIds.not query string No Related neoplastic entities - Filter for full text mismatches
relatedEntitiesIds.not.anyOf query array No Related neoplastic entities - Filter for entries where at least one reference mismatches the query
relatedEntitiesIds.not.beginsWith query string No Related neoplastic entities - Filter for entries not starting with the text
relatedEntitiesIds.not.contains query string No Related neoplastic entities - Filter for partial text mismatches
relatedEntitiesIds.not.endsWith query string No Related neoplastic entities - Filter for entries not ending with the text
relatedEntitiesIds.not.exists query boolean No Related neoplastic entities - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        null
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/AnyTumorBoard"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[AnyTumorBoard]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/tumor-boards

Create Tumor Board

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/UnspecifiedTumorBoardCreate"
        },
        {
            "$ref": "#/components/schemas/MolecularTumorBoardCreate"
        }
    ],
    "title": "Payload"
}

Response 201 Created

{
    "id": "a23b2bf8-c57a-400c-8c21-055f3e532de7",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-boards/{tumorBoardId}

Get Tumor Board By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
tumorBoardId path string No

Response 200 OK

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/UnspecifiedTumorBoard"
        },
        {
            "$ref": "#/components/schemas/MolecularTumorBoard"
        }
    ]
}

Response 404 Not Found


PUT /api/v1/tumor-boards/{tumorBoardId}

Update Tumor Board

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorBoardId path string No

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/UnspecifiedTumorBoardCreate"
        },
        {
            "$ref": "#/components/schemas/MolecularTumorBoardCreate"
        }
    ],
    "title": "Payload"
}

Response 200 OK

{
    "id": "7774b9fb-6edf-498a-8ce8-1bb702ad256b",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/tumor-boards/{tumorBoardId}

Delete Tumor Board

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorBoardId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-boards/{tumorBoardId}/history/events

Get All Tumor Board History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
tumorBoardId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}

Get Tumor Board History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
tumorBoardId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a history event within the system.\n\nAttributes:\n    id (Any): The unique identifier of the history event.\n    resourceId (Any): The unique identifier of the tracked resource.\n    category (HistoryEventCategory): The type of history event.\n    timestamp (datetime): Timestamp of the history event.\n    user (Nullable[str]): Username of the user that triggered the event, if applicable.\n    url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n    resource (Nullable[str]): Resource involved in the event, if applicable.\n    snapshot (Dict): Data snapshot at the time of the event.\n    differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n    context (Nullable[Dict]): Context surrounding the event.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEvent",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/tumor-boards/{tumorBoardId}/history/events/{eventId}/reversion

Revert Tumor Board To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
tumorBoardId path string No

Response 201 Created

{
    "id": "7455f923-17d6-42c2-9a10-081abd65d68f",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations

Get Molecular Tumor Board Therapeutic Recommendations Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorBoardId path string No

Response 200 OK

[
    {
        "id": "32a1c7c5-dd49-4c7d-b530-aebb7b95c962",
        "description": "string",
        "createdAt": "2022-04-13T15:42:05.901Z",
        "updatedAt": "2022-04-13T15:42:05.901Z",
        "createdBy": "string",
        "updatedBy": [
            "string"
        ],
        "externalSource": "string",
        "externalSourceId": "string",
        "expectedEffect": null,
        "clinicalTrial": "string",
        "offLabelUse": true,
        "withinSoc": true,
        "drugs": [
            {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            }
        ],
        "supportingGenomicVariantsIds": [
            "363051ce-46e4-4411-a6ad-036c5246bcc3"
        ],
        "supportingGenomicSignaturesIds": [
            "c16026eb-e977-4fd6-9cad-428b6917b155"
        ],
        "supportingTumorMarkersIds": [
            "f0203122-3ee0-48a3-a4e0-f55c67c71125"
        ]
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/MolecularTherapeuticRecommendation"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations

Create Molecular Tumor Board Therapeutic Recommendation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
tumorBoardId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "expectedEffect": null,
    "clinicalTrial": "string",
    "offLabelUse": true,
    "withinSoc": true,
    "drugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "supportingGenomicVariantsIds": [
        "167ffbfb-2c67-4659-80eb-4e85f6786300"
    ],
    "supportingGenomicSignaturesIds": [
        "abc10e53-96f9-4cd9-9148-8649c6c48463"
    ],
    "supportingTumorMarkersIds": [
        "e184a5cd-adfb-4912-82b3-b6a66bf64bba"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "expectedEffect": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the expected effect of the drug",
            "title": "Expected medication action",
            "x-terminology": "ExpectedDrugAction"
        },
        "clinicalTrial": {
            "description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
            "maxLength": 15,
            "title": "Recommended clinical trial",
            "type": "string"
        },
        "offLabelUse": {
            "description": "Whether the medication(s) recommended were off-label",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Whether the medication(s) recommended were within standard of care",
            "title": "Within SOC",
            "type": "boolean"
        },
        "drugs": {
            "description": "Drugs(s) being recommended",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Drug(s)",
            "type": "array",
            "x-terminology": "AntineoplasticAgent"
        },
        "supportingGenomicVariantsIds": {
            "description": "Genomic variants that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic variants",
            "type": "array"
        },
        "supportingGenomicSignaturesIds": {
            "description": "Genomic signatures that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic signatures",
            "type": "array"
        },
        "supportingTumorMarkersIds": {
            "description": "Tumor markers that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting tumor markers",
            "type": "array"
        }
    },
    "title": "MolecularTherapeuticRecommendationCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "bbd87978-1055-4147-95f2-389985949334",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}

Get Molecular Tumor Board Therapeutic Recommendation By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
recommendationId path string No
tumorBoardId path string No

Response 200 OK

{
    "id": "faecf0ca-769f-42df-aa4f-d26cddb38abc",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "expectedEffect": null,
    "clinicalTrial": "string",
    "offLabelUse": true,
    "withinSoc": true,
    "drugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "supportingGenomicVariantsIds": [
        "dcd1a34f-674e-4432-b1df-6de73c521007"
    ],
    "supportingGenomicSignaturesIds": [
        "c4d28eb7-948a-47f2-ac61-9e7d537bc0dd"
    ],
    "supportingTumorMarkersIds": [
        "d6bfe1d6-1ef5-426f-997c-003681af3760"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "expectedEffect": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the expected effect of the drug",
            "title": "Expected medication action",
            "x-terminology": "ExpectedDrugAction"
        },
        "clinicalTrial": {
            "description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
            "maxLength": 15,
            "title": "Recommended clinical trial",
            "type": "string"
        },
        "offLabelUse": {
            "description": "Whether the medication(s) recommended were off-label",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Whether the medication(s) recommended were within standard of care",
            "title": "Within SOC",
            "type": "boolean"
        },
        "drugs": {
            "description": "Drugs(s) being recommended",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Drug(s)",
            "type": "array",
            "x-terminology": "AntineoplasticAgent"
        },
        "supportingGenomicVariantsIds": {
            "description": "Genomic variants that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic variants",
            "type": "array"
        },
        "supportingGenomicSignaturesIds": {
            "description": "Genomic signatures that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic signatures",
            "type": "array"
        },
        "supportingTumorMarkersIds": {
            "description": "Tumor markers that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting tumor markers",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description"
    ],
    "title": "MolecularTherapeuticRecommendation",
    "type": "object"
}

Response 404 Not Found


PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}

Update Molecular Tumor Board Therapeutic Recommendation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
recommendationId path string No
tumorBoardId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "expectedEffect": null,
    "clinicalTrial": "string",
    "offLabelUse": true,
    "withinSoc": true,
    "drugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "supportingGenomicVariantsIds": [
        "da50bf7a-ab93-45f1-a0b0-f40c517fda80"
    ],
    "supportingGenomicSignaturesIds": [
        "dc8b9de8-f850-45b6-9884-920ac7b16cee"
    ],
    "supportingTumorMarkersIds": [
        "36fa5ce0-5e23-47e2-bfdd-d288b3bf555c"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "expectedEffect": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Classification of the expected effect of the drug",
            "title": "Expected medication action",
            "x-terminology": "ExpectedDrugAction"
        },
        "clinicalTrial": {
            "description": "Clinical trial (NCT-Iddentifier) recommended by the board for enrollment",
            "maxLength": 15,
            "title": "Recommended clinical trial",
            "type": "string"
        },
        "offLabelUse": {
            "description": "Whether the medication(s) recommended were off-label",
            "title": "Off-label use",
            "type": "boolean"
        },
        "withinSoc": {
            "description": "Whether the medication(s) recommended were within standard of care",
            "title": "Within SOC",
            "type": "boolean"
        },
        "drugs": {
            "description": "Drugs(s) being recommended",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Drug(s)",
            "type": "array",
            "x-terminology": "AntineoplasticAgent"
        },
        "supportingGenomicVariantsIds": {
            "description": "Genomic variants that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic variants",
            "type": "array"
        },
        "supportingGenomicSignaturesIds": {
            "description": "Genomic signatures that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting genomic signatures",
            "type": "array"
        },
        "supportingTumorMarkersIds": {
            "description": "Tumor markers that support the recommendation",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Supporting tumor markers",
            "type": "array"
        }
    },
    "title": "MolecularTherapeuticRecommendationCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "6d32b04f-1a8d-4698-bc9f-b7fc68093f79",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}

Delete Molecular Tumor Board Therapeutic Recommendation

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
recommendationId path string No
tumorBoardId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events

Get All Molecular Tumor Board Therapeutic History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
recommendationId path string No
tumorBoardId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}

Get Molecular Tumor Board Therapeutic History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
recommendationId path string No
tumorBoardId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a history event within the system.\n\nAttributes:\n    id (Any): The unique identifier of the history event.\n    resourceId (Any): The unique identifier of the tracked resource.\n    category (HistoryEventCategory): The type of history event.\n    timestamp (datetime): Timestamp of the history event.\n    user (Nullable[str]): Username of the user that triggered the event, if applicable.\n    url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n    resource (Nullable[str]): Resource involved in the event, if applicable.\n    snapshot (Dict): Data snapshot at the time of the event.\n    differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n    context (Nullable[Dict]): Context surrounding the event.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEvent",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/molecular-tumor-boards/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}/reversion

Revert Molecular Tumor Board Therapeutic To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
recommendationId path string No
tumorBoardId path string No

Response 201 Created

{
    "id": "c27282f8-af20-43b3-b1b6-0b7af6bcaf48",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Performance Status


GET /api/v1/performance-status

Get All Performance Status Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
ecogInterpretation query string No ECOG Interpreation - Filter for a matching concept code
ecogInterpretation.anyOf query array No ECOG Interpreation - Filter for a matching set of concept codes
ecogInterpretation.descendantsOf query string No ECOG Interpreation - Filter for all child concepts of a given concepts code
ecogInterpretation.exists query boolean No ECOG Interpreation - Filter for entries with a value
ecogInterpretation.not query string No ECOG Interpreation - Filter for a mismatching concept code
ecogInterpretation.not.anyOf query array No ECOG Interpreation - Filter for a mismmatching set of concept codes
ecogInterpretation.not.exists query boolean No ECOG Interpreation - Filter for entries without a value
ecogScore.between query array No ECOG Score - Filter for entries with values between two specified values (inclusive)
ecogScore.equal query integer No ECOG Score - Filter for entries with values exactly equal to the specified value
ecogScore.exists query boolean No ECOG Score - Filter for entries with a value
ecogScore.greaterThan query integer No ECOG Score - Filter for entries with values greater than the specified value
ecogScore.greaterThanOrEqual query integer No ECOG Score - Filter for entries with values greater than or equal to the specified value
ecogScore.lessThan query integer No ECOG Score - Filter for entries with values less than the specified value
ecogScore.lessThanOrEqual query integer No ECOG Score - Filter for entries with values less than or equal to the specified value
ecogScore.not.between query array No ECOG Score - Filter for entries with values between two specified values (inclusive)
ecogScore.not.equal query integer No ECOG Score - Filter for entries with values not equal to the specified value
ecogScore.not.exists query boolean No ECOG Score - Filter for entries without a value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
karnofskyInterpretation query string No Karnofsky Interpreation - Filter for a matching concept code
karnofskyInterpretation.anyOf query array No Karnofsky Interpreation - Filter for a matching set of concept codes
karnofskyInterpretation.descendantsOf query string No Karnofsky Interpreation - Filter for all child concepts of a given concepts code
karnofskyInterpretation.exists query boolean No Karnofsky Interpreation - Filter for entries with a value
karnofskyInterpretation.not query string No Karnofsky Interpreation - Filter for a mismatching concept code
karnofskyInterpretation.not.anyOf query array No Karnofsky Interpreation - Filter for a mismmatching set of concept codes
karnofskyInterpretation.not.exists query boolean No Karnofsky Interpreation - Filter for entries without a value
karnofskyScore.between query array No Karnofsky Score - Filter for entries with values between two specified values (inclusive)
karnofskyScore.equal query integer No Karnofsky Score - Filter for entries with values exactly equal to the specified value
karnofskyScore.exists query boolean No Karnofsky Score - Filter for entries with a value
karnofskyScore.greaterThan query integer No Karnofsky Score - Filter for entries with values greater than the specified value
karnofskyScore.greaterThanOrEqual query integer No Karnofsky Score - Filter for entries with values greater than or equal to the specified value
karnofskyScore.lessThan query integer No Karnofsky Score - Filter for entries with values less than the specified value
karnofskyScore.lessThanOrEqual query integer No Karnofsky Score - Filter for entries with values less than or equal to the specified value
karnofskyScore.not.between query array No Karnofsky Score - Filter for entries with values between two specified values (inclusive)
karnofskyScore.not.equal query integer No Karnofsky Score - Filter for entries with values not equal to the specified value
karnofskyScore.not.exists query boolean No Karnofsky Score - Filter for entries without a value
limit query integer 10 No
offset query integer 0 No
ordering query None No
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "40861aa8-93d8-4744-8d6c-b7383911dea2",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "82cca030-0111-45b0-a1d6-990ec80add3b",
            "date": "2022-04-13",
            "ecogScore": 0,
            "karnofskyScore": 0,
            "ecogInterpretation": null,
            "karnofskyInterpretation": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/PerformanceStatus"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[PerformanceStatus]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/performance-status

Create Performance Status

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "dd90f7de-ddfb-483d-a377-71b88720e3f5",
    "date": "2022-04-13",
    "ecogScore": 0,
    "karnofskyScore": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's performance status is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the performance score was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "ecogScore": {
            "description": "ECOG Performance Status Score",
            "title": "ECOG Score",
            "type": "integer"
        },
        "karnofskyScore": {
            "description": "Karnofsky Performance Status Score",
            "title": "Karnofsky Score",
            "type": "integer"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "PerformanceStatusCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "177bfcc0-f254-44a8-9904-868b694647ec",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/performance-status/{performanceStatusId}

Get Performance Status By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
performanceStatusId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "4b21ba09-ae21-407d-bded-e9e07c268745",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "bbccf96b-a158-4db3-a863-d7258fcca591",
    "date": "2022-04-13",
    "ecogScore": 0,
    "karnofskyScore": 0,
    "ecogInterpretation": null,
    "karnofskyInterpretation": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's performance status is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the performance score was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "ecogScore": {
            "description": "ECOG Performance Status Score",
            "title": "ECOG Score",
            "type": "integer"
        },
        "karnofskyScore": {
            "description": "Karnofsky Performance Status Score",
            "title": "Karnofsky Score",
            "type": "integer"
        },
        "ecogInterpretation": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Official interpretation of the ECOG score",
            "title": "ECOG Interpreation",
            "x-terminology": "ECOGPerformanceStatusInterpretation"
        },
        "karnofskyInterpretation": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Official interpretation of the Karnofsky score",
            "title": "Karnofsky Interpreation",
            "x-terminology": "KarnofskyPerformanceStatusInterpretation"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date"
    ],
    "title": "PerformanceStatus",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/performance-status/{performanceStatusId}

Update Performance Status

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
performanceStatusId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "c5a54852-04e6-4c1d-8464-5f9fd1d42c13",
    "date": "2022-04-13",
    "ecogScore": 0,
    "karnofskyScore": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's performance status is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the performance score was performed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "ecogScore": {
            "description": "ECOG Performance Status Score",
            "title": "ECOG Score",
            "type": "integer"
        },
        "karnofskyScore": {
            "description": "Karnofsky Performance Status Score",
            "title": "Karnofsky Score",
            "type": "integer"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "PerformanceStatusCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "00b3ef6e-0416-4364-a899-02fa7afb9c9c",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/performance-status/{performanceStatusId}

Delete Performance Status

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
performanceStatusId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/performance-status/{performanceStatusId}/history/events

Get All Performance Status History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
performanceStatusId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}

Get Performance Status History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
performanceStatusId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/performance-status/{performanceStatusId}/history/events/{eventId}/reversion

Revert Performance Status To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
performanceStatusId path string No

Response 201 Created

{
    "id": "31c7c8b3-c2ce-48d7-9004-b591c49ad347",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Genomic Variants


GET /api/v1/genomic-variants

Get All Genomic Variants Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
alleleDepth.between query array No Allele depth (reads) - Filter for entries with values between two specified values (inclusive)
alleleDepth.equal query integer No Allele depth (reads) - Filter for entries with values exactly equal to the specified value
alleleDepth.exists query boolean No Allele depth (reads) - Filter for entries with a value
alleleDepth.greaterThan query integer No Allele depth (reads) - Filter for entries with values greater than the specified value
alleleDepth.greaterThanOrEqual query integer No Allele depth (reads) - Filter for entries with values greater than or equal to the specified value
alleleDepth.lessThan query integer No Allele depth (reads) - Filter for entries with values less than the specified value
alleleDepth.lessThanOrEqual query integer No Allele depth (reads) - Filter for entries with values less than or equal to the specified value
alleleDepth.not.between query array No Allele depth (reads) - Filter for entries with values between two specified values (inclusive)
alleleDepth.not.equal query integer No Allele depth (reads) - Filter for entries with values not equal to the specified value
alleleDepth.not.exists query boolean No Allele depth (reads) - Filter for entries without a value
alleleFrequency.between query array No Allele frequency - Filter for entries with values between two specified values (inclusive)
alleleFrequency.equal query number No Allele frequency - Filter for entries with values exactly equal to the specified value
alleleFrequency.exists query boolean No Allele frequency - Filter for entries with a value
alleleFrequency.greaterThan query number No Allele frequency - Filter for entries with values greater than the specified value
alleleFrequency.greaterThanOrEqual query number No Allele frequency - Filter for entries with values greater than or equal to the specified value
alleleFrequency.lessThan query number No Allele frequency - Filter for entries with values less than the specified value
alleleFrequency.lessThanOrEqual query number No Allele frequency - Filter for entries with values less than or equal to the specified value
alleleFrequency.not.between query array No Allele frequency - Filter for entries with values between two specified values (inclusive)
alleleFrequency.not.equal query number No Allele frequency - Filter for entries with values not equal to the specified value
alleleFrequency.not.exists query boolean No Allele frequency - Filter for entries without a value
analysisMethod query string No Analysis method - Filter for a matching concept code
analysisMethod.anyOf query array No Analysis method - Filter for a matching set of concept codes
analysisMethod.descendantsOf query string No Analysis method - Filter for all child concepts of a given concepts code
analysisMethod.exists query boolean No Analysis method - Filter for entries with a value
analysisMethod.not query string No Analysis method - Filter for a mismatching concept code
analysisMethod.not.anyOf query array No Analysis method - Filter for a mismmatching set of concept codes
analysisMethod.not.exists query boolean No Analysis method - Filter for entries without a value
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
assessment query None No Assessment - Filter for single value choice
assessment.anyOf query array No Assessment - ('Filter for excluding a subset of value choices',)
assessment.exists query boolean No Assessment - Filter for entries with a value
assessment.not query None No Assessment - ('Filter for all but a single value choice',)
assessment.not.exists query boolean No Assessment - Filter for entries without a value
assessmentDate.after query string No Assessment date - Filter for entries with dates after the specified value
assessmentDate.before query string No Assessment date - Filter for entries with dates before the specified value
assessmentDate.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
assessmentDate.exists query boolean No Assessment date - Filter for entries with a value
assessmentDate.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
assessmentDate.not.exists query boolean No Assessment date - Filter for entries without a value
assessmentDate.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
assessmentDate.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
assessmentDate.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
assessmentDate.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
clinicalRelevance query None No Clinical relevance - Filter for single value choice
clinicalRelevance.anyOf query array No Clinical relevance - ('Filter for excluding a subset of value choices',)
clinicalRelevance.exists query boolean No Clinical relevance - Filter for entries with a value
clinicalRelevance.not query None No Clinical relevance - ('Filter for all but a single value choice',)
clinicalRelevance.not.exists query boolean No Clinical relevance - Filter for entries without a value
clinvar query string No ClinVar accession number - Filter for full text matches
clinvar.anyOf query array No ClinVar accession number - Filter for entries where at least one reference matches the query
clinvar.beginsWith query string No ClinVar accession number - Filter for entries starting with the text
clinvar.contains query string No ClinVar accession number - Filter for partial text matches
clinvar.endsWith query string No ClinVar accession number - Filter for entries ending with the text
clinvar.exists query boolean No ClinVar accession number - Filter for entries with a value
clinvar.not query string No ClinVar accession number - Filter for full text mismatches
clinvar.not.anyOf query array No ClinVar accession number - Filter for entries where at least one reference mismatches the query
clinvar.not.beginsWith query string No ClinVar accession number - Filter for entries not starting with the text
clinvar.not.contains query string No ClinVar accession number - Filter for partial text mismatches
clinvar.not.endsWith query string No ClinVar accession number - Filter for entries not ending with the text
clinvar.not.exists query boolean No ClinVar accession number - Filter for entries without a value
confidence query None No Confidence - Filter for single value choice
confidence.anyOf query array No Confidence - ('Filter for excluding a subset of value choices',)
confidence.exists query boolean No Confidence - Filter for entries with a value
confidence.not query None No Confidence - ('Filter for all but a single value choice',)
confidence.not.exists query boolean No Confidence - Filter for entries without a value
coordinateSystem query string No Coordinate system - Filter for a matching concept code
coordinateSystem.anyOf query array No Coordinate system - Filter for a matching set of concept codes
coordinateSystem.descendantsOf query string No Coordinate system - Filter for all child concepts of a given concepts code
coordinateSystem.exists query boolean No Coordinate system - Filter for entries with a value
coordinateSystem.not query string No Coordinate system - Filter for a mismatching concept code
coordinateSystem.not.anyOf query array No Coordinate system - Filter for a mismmatching set of concept codes
coordinateSystem.not.exists query boolean No Coordinate system - Filter for entries without a value
copyNumber.between query array No Copy number - Filter for entries with values between two specified values (inclusive)
copyNumber.equal query integer No Copy number - Filter for entries with values exactly equal to the specified value
copyNumber.exists query boolean No Copy number - Filter for entries with a value
copyNumber.greaterThan query integer No Copy number - Filter for entries with values greater than the specified value
copyNumber.greaterThanOrEqual query integer No Copy number - Filter for entries with values greater than or equal to the specified value
copyNumber.lessThan query integer No Copy number - Filter for entries with values less than the specified value
copyNumber.lessThanOrEqual query integer No Copy number - Filter for entries with values less than or equal to the specified value
copyNumber.not.between query array No Copy number - Filter for entries with values between two specified values (inclusive)
copyNumber.not.equal query integer No Copy number - Filter for entries with values not equal to the specified value
copyNumber.not.exists query boolean No Copy number - Filter for entries without a value
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Date - Filter for entries with dates after the specified value
date.before query string No Date - Filter for entries with dates before the specified value
date.between query array No Date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Date - Filter for entries with dates not matching the specified value
date.on query string No Date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Date - Filter for entries with dates on or before the specified value
dnaChangePosition.between query array No DNA change position - Filter for entries with values between two specified values (inclusive)
dnaChangePosition.equal query integer No DNA change position - Filter for entries with values exactly equal to the specified value
dnaChangePosition.exists query boolean No DNA change position - Filter for entries with a value
dnaChangePosition.greaterThan query integer No DNA change position - Filter for entries with values greater than the specified value
dnaChangePosition.greaterThanOrEqual query integer No DNA change position - Filter for entries with values greater than or equal to the specified value
dnaChangePosition.lessThan query integer No DNA change position - Filter for entries with values less than the specified value
dnaChangePosition.lessThanOrEqual query integer No DNA change position - Filter for entries with values less than or equal to the specified value
dnaChangePosition.not.between query array No DNA change position - Filter for entries with values between two specified values (inclusive)
dnaChangePosition.not.equal query integer No DNA change position - Filter for entries with values not equal to the specified value
dnaChangePosition.not.exists query boolean No DNA change position - Filter for entries without a value
dnaChangePositionRange.containedBy query array No DNA change range - Filter for entries whose Range are contined by the range
dnaChangePositionRange.contains query array No DNA change range - Filter for entries containing the range
dnaChangePositionRange.exists query boolean No DNA change range - Filter for entries with a value
dnaChangePositionRange.not.containedBy query array No DNA change range - Filter for entries whose Range are not contined by the range
dnaChangePositionRange.not.contains query array No DNA change range - Filter for entries not containing the range
dnaChangePositionRange.not.exists query boolean No DNA change range - Filter for entries without a value
dnaChangePositionRange.not.overlaps query array No DNA change range - Filter for entries not overlapping with the range
dnaChangePositionRange.overlaps query array No DNA change range - Filter for entries overlapping with the range
dnaChangeType query None No DNA change type - Filter for single value choice
dnaChangeType.anyOf query array No DNA change type - ('Filter for excluding a subset of value choices',)
dnaChangeType.exists query boolean No DNA change type - Filter for entries with a value
dnaChangeType.not query None No DNA change type - ('Filter for all but a single value choice',)
dnaChangeType.not.exists query boolean No DNA change type - Filter for entries without a value
dnaHgvs query string No DNA HGVS - Filter for full text matches
dnaHgvs.anyOf query array No DNA HGVS - Filter for entries where at least one reference matches the query
dnaHgvs.beginsWith query string No DNA HGVS - Filter for entries starting with the text
dnaHgvs.contains query string No DNA HGVS - Filter for partial text matches
dnaHgvs.endsWith query string No DNA HGVS - Filter for entries ending with the text
dnaHgvs.exists query boolean No DNA HGVS - Filter for entries with a value
dnaHgvs.not query string No DNA HGVS - Filter for full text mismatches
dnaHgvs.not.anyOf query array No DNA HGVS - Filter for entries where at least one reference mismatches the query
dnaHgvs.not.beginsWith query string No DNA HGVS - Filter for entries not starting with the text
dnaHgvs.not.contains query string No DNA HGVS - Filter for partial text mismatches
dnaHgvs.not.endsWith query string No DNA HGVS - Filter for entries not ending with the text
dnaHgvs.not.exists query boolean No DNA HGVS - Filter for entries without a value
dnaReferenceSequence query string No DNA HGVS RefSeq - Filter for full text matches
dnaReferenceSequence.anyOf query array No DNA HGVS RefSeq - Filter for entries where at least one reference matches the query
dnaReferenceSequence.beginsWith query string No DNA HGVS RefSeq - Filter for entries starting with the text
dnaReferenceSequence.contains query string No DNA HGVS RefSeq - Filter for partial text matches
dnaReferenceSequence.endsWith query string No DNA HGVS RefSeq - Filter for entries ending with the text
dnaReferenceSequence.exists query boolean No DNA HGVS RefSeq - Filter for entries with a value
dnaReferenceSequence.not query string No DNA HGVS RefSeq - Filter for full text mismatches
dnaReferenceSequence.not.anyOf query array No DNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query
dnaReferenceSequence.not.beginsWith query string No DNA HGVS RefSeq - Filter for entries not starting with the text
dnaReferenceSequence.not.contains query string No DNA HGVS RefSeq - Filter for partial text mismatches
dnaReferenceSequence.not.endsWith query string No DNA HGVS RefSeq - Filter for entries not ending with the text
dnaReferenceSequence.not.exists query boolean No DNA HGVS RefSeq - Filter for entries without a value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
genePanel query string No Gene panel - Filter for full text matches
genePanel.anyOf query array No Gene panel - Filter for entries where at least one reference matches the query
genePanel.beginsWith query string No Gene panel - Filter for entries starting with the text
genePanel.contains query string No Gene panel - Filter for partial text matches
genePanel.endsWith query string No Gene panel - Filter for entries ending with the text
genePanel.exists query boolean No Gene panel - Filter for entries with a value
genePanel.not query string No Gene panel - Filter for full text mismatches
genePanel.not.anyOf query array No Gene panel - Filter for entries where at least one reference mismatches the query
genePanel.not.beginsWith query string No Gene panel - Filter for entries not starting with the text
genePanel.not.contains query string No Gene panel - Filter for partial text mismatches
genePanel.not.endsWith query string No Gene panel - Filter for entries not ending with the text
genePanel.not.exists query boolean No Gene panel - Filter for entries without a value
genes query string No Gene(s) - Filter for a matching concept code
genes.allOf query array No Gene(s) - Filter for entries matching all of the concepts
genes.anyOf query array No Gene(s) - Filter for a matching set of concept codes
genes.descendantsOf query string No Gene(s) - Filter for all child concepts of a given concepts code
genes.not query string No Gene(s) - Filter for a mismatching concept code
genes.not.allOf query array No Gene(s) - Filter for entries mismatching all of the concepts
genes.not.anyOf query array No Gene(s) - Filter for a mismmatching set of concept codes
genomeAssemblyVersion query string No Genome assembly version - Filter for a matching concept code
genomeAssemblyVersion.anyOf query array No Genome assembly version - Filter for a matching set of concept codes
genomeAssemblyVersion.descendantsOf query string No Genome assembly version - Filter for all child concepts of a given concepts code
genomeAssemblyVersion.exists query boolean No Genome assembly version - Filter for entries with a value
genomeAssemblyVersion.not query string No Genome assembly version - Filter for a mismatching concept code
genomeAssemblyVersion.not.anyOf query array No Genome assembly version - Filter for a mismmatching set of concept codes
genomeAssemblyVersion.not.exists query boolean No Genome assembly version - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
inheritance query string No Inheritance - Filter for a matching concept code
inheritance.anyOf query array No Inheritance - Filter for a matching set of concept codes
inheritance.descendantsOf query string No Inheritance - Filter for all child concepts of a given concepts code
inheritance.exists query boolean No Inheritance - Filter for entries with a value
inheritance.not query string No Inheritance - Filter for a mismatching concept code
inheritance.not.anyOf query array No Inheritance - Filter for a mismmatching set of concept codes
inheritance.not.exists query boolean No Inheritance - Filter for entries without a value
isPathogenic query boolean No Is Pathogenic - Filter for yes/no statement
isPathogenic.exists query boolean No Is Pathogenic - Filter for entries with a value
isPathogenic.not.exists query boolean No Is Pathogenic - Filter for entries without a value
isVUS query boolean No Is VUS - Filter for yes/no statement
isVUS.exists query boolean No Is VUS - Filter for entries with a value
isVUS.not.exists query boolean No Is VUS - Filter for entries without a value
limit query integer 10 No
molecularConsequence query string No Molecular consequence - Filter for a matching concept code
molecularConsequence.anyOf query array No Molecular consequence - Filter for a matching set of concept codes
molecularConsequence.descendantsOf query string No Molecular consequence - Filter for all child concepts of a given concepts code
molecularConsequence.exists query boolean No Molecular consequence - Filter for entries with a value
molecularConsequence.not query string No Molecular consequence - Filter for a mismatching concept code
molecularConsequence.not.anyOf query array No Molecular consequence - Filter for a mismmatching set of concept codes
molecularConsequence.not.exists query boolean No Molecular consequence - Filter for entries without a value
nucleotidesLength.between query array No Variant length - Filter for entries with values between two specified values (inclusive)
nucleotidesLength.equal query integer No Variant length - Filter for entries with values exactly equal to the specified value
nucleotidesLength.exists query boolean No Variant length - Filter for entries with a value
nucleotidesLength.greaterThan query integer No Variant length - Filter for entries with values greater than the specified value
nucleotidesLength.greaterThanOrEqual query integer No Variant length - Filter for entries with values greater than or equal to the specified value
nucleotidesLength.lessThan query integer No Variant length - Filter for entries with values less than the specified value
nucleotidesLength.lessThanOrEqual query integer No Variant length - Filter for entries with values less than or equal to the specified value
nucleotidesLength.not.between query array No Variant length - Filter for entries with values between two specified values (inclusive)
nucleotidesLength.not.equal query integer No Variant length - Filter for entries with values not equal to the specified value
nucleotidesLength.not.exists query boolean No Variant length - Filter for entries without a value
offset query integer 0 No
ordering query None No
proteinChangeType query None No Protein change type - Filter for single value choice
proteinChangeType.anyOf query array No Protein change type - ('Filter for excluding a subset of value choices',)
proteinChangeType.exists query boolean No Protein change type - Filter for entries with a value
proteinChangeType.not query None No Protein change type - ('Filter for all but a single value choice',)
proteinChangeType.not.exists query boolean No Protein change type - Filter for entries without a value
proteinHgvs query string No Protein HGVS - Filter for full text matches
proteinHgvs.anyOf query array No Protein HGVS - Filter for entries where at least one reference matches the query
proteinHgvs.beginsWith query string No Protein HGVS - Filter for entries starting with the text
proteinHgvs.contains query string No Protein HGVS - Filter for partial text matches
proteinHgvs.endsWith query string No Protein HGVS - Filter for entries ending with the text
proteinHgvs.exists query boolean No Protein HGVS - Filter for entries with a value
proteinHgvs.not query string No Protein HGVS - Filter for full text mismatches
proteinHgvs.not.anyOf query array No Protein HGVS - Filter for entries where at least one reference mismatches the query
proteinHgvs.not.beginsWith query string No Protein HGVS - Filter for entries not starting with the text
proteinHgvs.not.contains query string No Protein HGVS - Filter for partial text mismatches
proteinHgvs.not.endsWith query string No Protein HGVS - Filter for entries not ending with the text
proteinHgvs.not.exists query boolean No Protein HGVS - Filter for entries without a value
proteinReferenceSequence query string No Protein HGVS RefSeq - Filter for full text matches
proteinReferenceSequence.anyOf query array No Protein HGVS RefSeq - Filter for entries where at least one reference matches the query
proteinReferenceSequence.beginsWith query string No Protein HGVS RefSeq - Filter for entries starting with the text
proteinReferenceSequence.contains query string No Protein HGVS RefSeq - Filter for partial text matches
proteinReferenceSequence.endsWith query string No Protein HGVS RefSeq - Filter for entries ending with the text
proteinReferenceSequence.exists query boolean No Protein HGVS RefSeq - Filter for entries with a value
proteinReferenceSequence.not query string No Protein HGVS RefSeq - Filter for full text mismatches
proteinReferenceSequence.not.anyOf query array No Protein HGVS RefSeq - Filter for entries where at least one reference mismatches the query
proteinReferenceSequence.not.beginsWith query string No Protein HGVS RefSeq - Filter for entries not starting with the text
proteinReferenceSequence.not.contains query string No Protein HGVS RefSeq - Filter for partial text mismatches
proteinReferenceSequence.not.endsWith query string No Protein HGVS RefSeq - Filter for entries not ending with the text
proteinReferenceSequence.not.exists query boolean No Protein HGVS RefSeq - Filter for entries without a value
regions query string No Gene regions - Filter for full text matches
regions.anyOf query array No Gene regions - Filter for entries where at least one reference matches the query
regions.beginsWith query string No Gene regions - Filter for entries starting with the text
regions.contains query string No Gene regions - Filter for partial text matches
regions.endsWith query string No Gene regions - Filter for entries ending with the text
regions.exists query boolean No Gene regions - Filter for entries with a value
regions.not query string No Gene regions - Filter for full text mismatches
regions.not.anyOf query array No Gene regions - Filter for entries where at least one reference mismatches the query
regions.not.beginsWith query string No Gene regions - Filter for entries not starting with the text
regions.not.contains query string No Gene regions - Filter for partial text mismatches
regions.not.endsWith query string No Gene regions - Filter for entries not ending with the text
regions.not.exists query boolean No Gene regions - Filter for entries without a value
rnaChangePosition query string No RNA change position - Filter for full text matches
rnaChangePosition.anyOf query array No RNA change position - Filter for entries where at least one reference matches the query
rnaChangePosition.beginsWith query string No RNA change position - Filter for entries starting with the text
rnaChangePosition.contains query string No RNA change position - Filter for partial text matches
rnaChangePosition.endsWith query string No RNA change position - Filter for entries ending with the text
rnaChangePosition.exists query boolean No RNA change position - Filter for entries with a value
rnaChangePosition.not query string No RNA change position - Filter for full text mismatches
rnaChangePosition.not.anyOf query array No RNA change position - Filter for entries where at least one reference mismatches the query
rnaChangePosition.not.beginsWith query string No RNA change position - Filter for entries not starting with the text
rnaChangePosition.not.contains query string No RNA change position - Filter for partial text mismatches
rnaChangePosition.not.endsWith query string No RNA change position - Filter for entries not ending with the text
rnaChangePosition.not.exists query boolean No RNA change position - Filter for entries without a value
rnaChangeType query None No RNA change type - Filter for single value choice
rnaChangeType.anyOf query array No RNA change type - ('Filter for excluding a subset of value choices',)
rnaChangeType.exists query boolean No RNA change type - Filter for entries with a value
rnaChangeType.not query None No RNA change type - ('Filter for all but a single value choice',)
rnaChangeType.not.exists query boolean No RNA change type - Filter for entries without a value
rnaHgvs query string No RNA HGVS - Filter for full text matches
rnaHgvs.anyOf query array No RNA HGVS - Filter for entries where at least one reference matches the query
rnaHgvs.beginsWith query string No RNA HGVS - Filter for entries starting with the text
rnaHgvs.contains query string No RNA HGVS - Filter for partial text matches
rnaHgvs.endsWith query string No RNA HGVS - Filter for entries ending with the text
rnaHgvs.exists query boolean No RNA HGVS - Filter for entries with a value
rnaHgvs.not query string No RNA HGVS - Filter for full text mismatches
rnaHgvs.not.anyOf query array No RNA HGVS - Filter for entries where at least one reference mismatches the query
rnaHgvs.not.beginsWith query string No RNA HGVS - Filter for entries not starting with the text
rnaHgvs.not.contains query string No RNA HGVS - Filter for partial text mismatches
rnaHgvs.not.endsWith query string No RNA HGVS - Filter for entries not ending with the text
rnaHgvs.not.exists query boolean No RNA HGVS - Filter for entries without a value
rnaReferenceSequence query string No RNA HGVS RefSeq - Filter for full text matches
rnaReferenceSequence.anyOf query array No RNA HGVS RefSeq - Filter for entries where at least one reference matches the query
rnaReferenceSequence.beginsWith query string No RNA HGVS RefSeq - Filter for entries starting with the text
rnaReferenceSequence.contains query string No RNA HGVS RefSeq - Filter for partial text matches
rnaReferenceSequence.endsWith query string No RNA HGVS RefSeq - Filter for entries ending with the text
rnaReferenceSequence.exists query boolean No RNA HGVS RefSeq - Filter for entries with a value
rnaReferenceSequence.not query string No RNA HGVS RefSeq - Filter for full text mismatches
rnaReferenceSequence.not.anyOf query array No RNA HGVS RefSeq - Filter for entries where at least one reference mismatches the query
rnaReferenceSequence.not.beginsWith query string No RNA HGVS RefSeq - Filter for entries not starting with the text
rnaReferenceSequence.not.contains query string No RNA HGVS RefSeq - Filter for partial text mismatches
rnaReferenceSequence.not.endsWith query string No RNA HGVS RefSeq - Filter for entries not ending with the text
rnaReferenceSequence.not.exists query boolean No RNA HGVS RefSeq - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
zygosity query string No Zygosity - Filter for a matching concept code
zygosity.anyOf query array No Zygosity - Filter for a matching set of concept codes
zygosity.descendantsOf query string No Zygosity - Filter for all child concepts of a given concepts code
zygosity.exists query boolean No Zygosity - Filter for entries with a value
zygosity.not query string No Zygosity - Filter for a mismatching concept code
zygosity.not.anyOf query array No Zygosity - Filter for a mismmatching set of concept codes
zygosity.not.exists query boolean No Zygosity - Filter for entries without a value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "a51509ab-2ea6-46c5-b3f5-f79befff3b88",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "32bb7e63-9d15-477f-acb2-9f25e64d84d9",
            "date": "2022-04-13",
            "genes": [
                {
                    "code": "string",
                    "system": "string",
                    "display": "string",
                    "version": "string",
                    "synonyms": [
                        "string"
                    ],
                    "properties": {}
                }
            ],
            "dnaHgvs": "string",
            "rnaHgvs": "string",
            "proteinHgvs": "string",
            "assessmentDate": "2022-04-13",
            "genePanel": "string",
            "assessment": null,
            "confidence": null,
            "analysisMethod": null,
            "clinicalRelevance": null,
            "genomeAssemblyVersion": null,
            "molecularConsequence": null,
            "copyNumber": 0,
            "alleleFrequency": 10.12,
            "alleleDepth": 0,
            "zygosity": null,
            "inheritance": null,
            "coordinateSystem": null,
            "clinvar": "string",
            "isPathogenic": true,
            "isVUS": true,
            "dnaReferenceSequence": "string",
            "dnaChangePosition": 0,
            "dnaChangePositionRange": null,
            "dnaChangeType": null,
            "rnaReferenceSequence": "string",
            "rnaChangePosition": "string",
            "rnaChangeType": null,
            "proteinReferenceSequence": "string",
            "proteinChangeType": null,
            "nucleotidesLength": 0,
            "regions": [
                "string"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/GenomicVariant"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[GenomicVariant]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/genomic-variants

Create Genomic Variant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "c1fd1fe7-98f3-4b08-923a-8b6d9483f25b",
    "date": "2022-04-13",
    "genes": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "dnaHgvs": "string",
    "rnaHgvs": "string",
    "proteinHgvs": "string",
    "assessmentDate": "2022-04-13",
    "genePanel": "string",
    "assessment": null,
    "confidence": null,
    "analysisMethod": null,
    "clinicalRelevance": null,
    "genomeAssemblyVersion": null,
    "molecularConsequence": null,
    "copyNumber": 0,
    "alleleFrequency": 10.12,
    "alleleDepth": 0,
    "zygosity": null,
    "inheritance": null,
    "coordinateSystem": null,
    "clinvar": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who' genomic variant is described",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "genes": {
            "description": "Gene(s) affected by this variant",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Gene(s)",
            "type": "array",
            "x-terminology": "Gene"
        },
        "dnaHgvs": {
            "description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
            "title": "DNA HGVS",
            "type": "string"
        },
        "rnaHgvs": {
            "description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
            "title": "RNA HGVS",
            "type": "string"
        },
        "proteinHgvs": {
            "description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
            "title": "Protein HGVS",
            "type": "string"
        },
        "assessmentDate": {
            "description": "Date at which the genomic variant was assessed and/or reported.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "genePanel": {
            "description": "Commercial or official name of the gene panel tested to identify the variant",
            "maxLength": 200,
            "title": "Gene panel",
            "type": "string"
        },
        "assessment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
                }
            ],
            "description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
            "title": "Assessment"
        },
        "confidence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
                }
            ],
            "description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
            "title": "Confidence"
        },
        "analysisMethod": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Analysis method used to detect the variant",
            "title": "Analysis method",
            "x-terminology": "StructuralVariantAnalysisMethod"
        },
        "clinicalRelevance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
                }
            ],
            "description": "Classification of the clinical relevance or pathogenicity of the variant.",
            "title": "Clinical relevance"
        },
        "genomeAssemblyVersion": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The reference genome assembly versionused in this analysis.",
            "title": "Genome assembly version",
            "x-terminology": "ReferenceGenomeBuild"
        },
        "molecularConsequence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
            "title": "Molecular consequence",
            "x-terminology": "MolecularConsequence"
        },
        "copyNumber": {
            "description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
            "title": "Copy number",
            "type": "integer"
        },
        "alleleFrequency": {
            "description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
            "title": "Allele frequency",
            "type": "number"
        },
        "alleleDepth": {
            "description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
            "title": "Allele depth (reads)",
            "type": "integer"
        },
        "zygosity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The observed level of occurrence of the variant in the set of chromosomes.",
            "title": "Zygosity",
            "x-terminology": "Zygosity"
        },
        "inheritance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Variant inheritance origin (if known).",
            "title": "Inheritance",
            "x-terminology": "VariantInheritance"
        },
        "coordinateSystem": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
            "title": "Coordinate system",
            "x-terminology": "GenomicCoordinateSystem"
        },
        "clinvar": {
            "description": "Accession number in the ClinVar variant database, given for cross-reference.",
            "title": "ClinVar accession number",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "date",
        "genes"
    ],
    "title": "GenomicVariantCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "45a98b24-3ca0-434d-9b4f-78c4a999916c",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-variants/{genomicVariantId}

Get Genomic Variant By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
genomicVariantId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "108d8421-35a8-4096-8297-22875734179c",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "306605cf-706b-4f26-8351-08736a612a52",
    "date": "2022-04-13",
    "genes": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "dnaHgvs": "string",
    "rnaHgvs": "string",
    "proteinHgvs": "string",
    "assessmentDate": "2022-04-13",
    "genePanel": "string",
    "assessment": null,
    "confidence": null,
    "analysisMethod": null,
    "clinicalRelevance": null,
    "genomeAssemblyVersion": null,
    "molecularConsequence": null,
    "copyNumber": 0,
    "alleleFrequency": 10.12,
    "alleleDepth": 0,
    "zygosity": null,
    "inheritance": null,
    "coordinateSystem": null,
    "clinvar": "string",
    "isPathogenic": true,
    "isVUS": true,
    "dnaReferenceSequence": "string",
    "dnaChangePosition": 0,
    "dnaChangePositionRange": null,
    "dnaChangeType": null,
    "rnaReferenceSequence": "string",
    "rnaChangePosition": "string",
    "rnaChangeType": null,
    "proteinReferenceSequence": "string",
    "proteinChangeType": null,
    "nucleotidesLength": 0,
    "regions": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who' genomic variant is described",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "genes": {
            "description": "Gene(s) affected by this variant",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Gene(s)",
            "type": "array",
            "x-terminology": "Gene"
        },
        "dnaHgvs": {
            "description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
            "title": "DNA HGVS",
            "type": "string"
        },
        "rnaHgvs": {
            "description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
            "title": "RNA HGVS",
            "type": "string"
        },
        "proteinHgvs": {
            "description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
            "title": "Protein HGVS",
            "type": "string"
        },
        "assessmentDate": {
            "description": "Date at which the genomic variant was assessed and/or reported.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "genePanel": {
            "description": "Commercial or official name of the gene panel tested to identify the variant",
            "maxLength": 200,
            "title": "Gene panel",
            "type": "string"
        },
        "assessment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
                }
            ],
            "description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
            "title": "Assessment"
        },
        "confidence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
                }
            ],
            "description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
            "title": "Confidence"
        },
        "analysisMethod": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Analysis method used to detect the variant",
            "title": "Analysis method",
            "x-terminology": "StructuralVariantAnalysisMethod"
        },
        "clinicalRelevance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
                }
            ],
            "description": "Classification of the clinical relevance or pathogenicity of the variant.",
            "title": "Clinical relevance"
        },
        "genomeAssemblyVersion": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The reference genome assembly versionused in this analysis.",
            "title": "Genome assembly version",
            "x-terminology": "ReferenceGenomeBuild"
        },
        "molecularConsequence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
            "title": "Molecular consequence",
            "x-terminology": "MolecularConsequence"
        },
        "copyNumber": {
            "description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
            "title": "Copy number",
            "type": "integer"
        },
        "alleleFrequency": {
            "description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
            "title": "Allele frequency",
            "type": "number"
        },
        "alleleDepth": {
            "description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
            "title": "Allele depth (reads)",
            "type": "integer"
        },
        "zygosity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The observed level of occurrence of the variant in the set of chromosomes.",
            "title": "Zygosity",
            "x-terminology": "Zygosity"
        },
        "inheritance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Variant inheritance origin (if known).",
            "title": "Inheritance",
            "x-terminology": "VariantInheritance"
        },
        "coordinateSystem": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
            "title": "Coordinate system",
            "x-terminology": "GenomicCoordinateSystem"
        },
        "clinvar": {
            "description": "Accession number in the ClinVar variant database, given for cross-reference.",
            "title": "ClinVar accession number",
            "type": "string"
        },
        "isPathogenic": {
            "description": "Whether the genomic variant is considered pathogenic in a clinical setting",
            "title": "Is Pathogenic",
            "type": "boolean"
        },
        "isVUS": {
            "description": "Whether the genomic variant is considered a variant of unknown signifiance (VUS)",
            "title": "Is VUS",
            "type": "boolean"
        },
        "dnaReferenceSequence": {
            "description": "DNA reference sequence identifier used as dna HGVS reference.",
            "pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})|(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)",
            "title": "DNA HGVS RefSeq",
            "type": "string"
        },
        "dnaChangePosition": {
            "description": "DNA-level single-nucleotide position where the variant was found.",
            "title": "DNA change position",
            "type": "integer"
        },
        "dnaChangePositionRange": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Range"
                }
            ],
            "description": "DNA-level single-nucleotide position where the variant was found.",
            "title": "DNA change range"
        },
        "dnaChangeType": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/DNAChangeType"
                }
            ],
            "description": "DNA variant type of variant.",
            "title": "DNA change type"
        },
        "rnaReferenceSequence": {
            "description": "RNA reference sequence identifier used as rna HGVS reference.",
            "pattern": "(?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})",
            "title": "RNA HGVS RefSeq",
            "type": "string"
        },
        "rnaChangePosition": {
            "description": "RNA-level nucleotide position/range where the variant was found.",
            "pattern": "(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))",
            "title": "RNA change position",
            "type": "string"
        },
        "rnaChangeType": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/RNAChangeType"
                }
            ],
            "description": "RNA variant type of variant.",
            "title": "RNA change type"
        },
        "proteinReferenceSequence": {
            "description": "Protein reference sequence identifier used as protein HGVS reference.",
            "pattern": "(?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})",
            "title": "Protein HGVS RefSeq",
            "type": "string"
        },
        "proteinChangeType": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProteinChangeType"
                }
            ],
            "description": "Protein variant type of variant.",
            "title": "Protein change type"
        },
        "nucleotidesLength": {
            "description": "Length of the variant in nucleotides",
            "title": "Variant length",
            "type": "integer"
        },
        "regions": {
            "description": "Gene regions (exons, introns, UTRs) affected by the variant. Estimated from MANE reference sequences.",
            "items": {
                "type": "string"
            },
            "title": "Gene regions",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "genes"
    ],
    "title": "GenomicVariant",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/genomic-variants/{genomicVariantId}

Update Genomic Variant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicVariantId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "4b91b0ed-8807-4326-9018-c45a592fe7fe",
    "date": "2022-04-13",
    "genes": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "dnaHgvs": "string",
    "rnaHgvs": "string",
    "proteinHgvs": "string",
    "assessmentDate": "2022-04-13",
    "genePanel": "string",
    "assessment": null,
    "confidence": null,
    "analysisMethod": null,
    "clinicalRelevance": null,
    "genomeAssemblyVersion": null,
    "molecularConsequence": null,
    "copyNumber": 0,
    "alleleFrequency": 10.12,
    "alleleDepth": 0,
    "zygosity": null,
    "inheritance": null,
    "coordinateSystem": null,
    "clinvar": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who' genomic variant is described",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date of the genomic variant (e.g. the specimen collection date).",
            "format": "date",
            "title": "Date",
            "type": "string"
        },
        "genes": {
            "description": "Gene(s) affected by this variant",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Gene(s)",
            "type": "array",
            "x-terminology": "Gene"
        },
        "dnaHgvs": {
            "description": "DNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g)|(?:(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+))?\\(?((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3}))\\)?:)?c))\\.((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+>(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins\\[(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\]\\sand\\s(?:(?:(?:(?:NC_|AC_|NG_|NT_|NW_|NZ_|GCF_)\\d+(?:\\.\\d{1,3})?)|(?:ENSG\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+)):)?g\\.(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:A|C|G|T|B|D|H|K|M|N|R|S|V|W|Y|X|-)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|gom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|lom|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))\\|met=)",
            "title": "DNA HGVS",
            "type": "string"
        },
        "rnaHgvs": {
            "description": "RNA HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:NM_|NR_|XM_|XR_)\\d+(?:\\.\\d{1,3})?)|(?:ENST\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+t\\d{1,3})):)?r\\.\\(?((?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))=|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+>(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))delins(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))ins(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+|(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))))|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))del|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))dup|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))inv|(?:(?:(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\))_(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))|(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))|\\((?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))_(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+))\\)))(?:(?:a|c|g|t|b|d|h|k|m|n|r|s|v|w|y)+)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\])\\)?",
            "title": "RNA HGVS",
            "type": "string"
        },
        "proteinHgvs": {
            "description": "Protein HGVS expression (g-coordinate expression, HGVS version >=21.1)",
            "pattern": "(?:((?:(?:AP_|NP_|YP_|XP_|WP_)\\d+(?:\\.\\d{1,3})?)|(?:ENSP\\d+(?:\\.\\d{1,3})?)|(?:LRG_\\d+p\\d{1,3})):)?p\\.\\(?(0\\??|\\?|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))delins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))del|(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))ins(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))dup|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:Ter|\\*)|(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)?fs(?:Ter)?(?:(?:(?:(?:\\*\\d+(?:[\\+-]\\d+)?)|(?:-\\d+(?:[\\+-]\\d+)?)|(?:(?:(?:\\+|-)\\d+)|(?:(?:\\?|\\*|\\d+)(?:\\+|-)\\d+)))|(?:\\?|\\*|\\d+)))*|(?:(?:Met1ext-\\d+)|(?:Ter\\d+(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)extTer\\d+))|\\(?(?:(?:(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))_(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\)))))\\)?\\[(?:\\d+|(?:\\(\\d+_\\d+\\)))\\]|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))+)|(?:(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+|(?:(?:\\(\\?_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_\\?\\))|(?:\\((?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+_(?:Ter|(?:Gly|Ala|Val|Leu|Ile|Met|Phe|Trp|Pro|Ser|Thr|Cys|Tyr|Asn|Gln|Asp|Glu|Lys|Arg|His))\\d+\\))))=)\\)?",
            "title": "Protein HGVS",
            "type": "string"
        },
        "assessmentDate": {
            "description": "Date at which the genomic variant was assessed and/or reported.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "genePanel": {
            "description": "Commercial or official name of the gene panel tested to identify the variant",
            "maxLength": 200,
            "title": "Gene panel",
            "type": "string"
        },
        "assessment": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantAssessmentChoices"
                }
            ],
            "description": "Classification of whether the variant is present or absent in the analysis results. Relevant for genomic studies that report presence and absence of variants.",
            "title": "Assessment"
        },
        "confidence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantConfidenceChoices"
                }
            ],
            "description": "Classification of the confidence for a true positive variant call based e.g. calling thresholds or phred-scaled confidence scores.",
            "title": "Confidence"
        },
        "analysisMethod": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Analysis method used to detect the variant",
            "title": "Analysis method",
            "x-terminology": "StructuralVariantAnalysisMethod"
        },
        "clinicalRelevance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/GenomicVariantClinicalRelevanceChoices"
                }
            ],
            "description": "Classification of the clinical relevance or pathogenicity of the variant.",
            "title": "Clinical relevance"
        },
        "genomeAssemblyVersion": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The reference genome assembly versionused in this analysis.",
            "title": "Genome assembly version",
            "x-terminology": "ReferenceGenomeBuild"
        },
        "molecularConsequence": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.",
            "title": "Molecular consequence",
            "x-terminology": "MolecularConsequence"
        },
        "copyNumber": {
            "description": "Genomic structural variant copy number. It is a unit-less value. Note that a copy number of 1 can imply a deletion.",
            "title": "Copy number",
            "type": "integer"
        },
        "alleleFrequency": {
            "description": "The relative frequency (value in range [0,1]) of the allele at a given locus in the sample.",
            "title": "Allele frequency",
            "type": "number"
        },
        "alleleDepth": {
            "description": "Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides.",
            "title": "Allele depth (reads)",
            "type": "integer"
        },
        "zygosity": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "The observed level of occurrence of the variant in the set of chromosomes.",
            "title": "Zygosity",
            "x-terminology": "Zygosity"
        },
        "inheritance": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Variant inheritance origin (if known).",
            "title": "Inheritance",
            "x-terminology": "VariantInheritance"
        },
        "coordinateSystem": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Genomic coordinate system used for identifying nucleotides or amino acids within a sequence.",
            "title": "Coordinate system",
            "x-terminology": "GenomicCoordinateSystem"
        },
        "clinvar": {
            "description": "Accession number in the ClinVar variant database, given for cross-reference.",
            "title": "ClinVar accession number",
            "type": "string"
        }
    },
    "required": [
        "caseId",
        "date",
        "genes"
    ],
    "title": "GenomicVariantCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "dd0b5a18-cb49-4731-8ee8-3486d2e312fa",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/genomic-variants/{genomicVariantId}

Delete Genomic Variant

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicVariantId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-variants/{genomicVariantId}/history/events

Get All Genomic Variant History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicVariantId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}

Get Genomic Variant History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
genomicVariantId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/genomic-variants/{genomicVariantId}/history/events/{eventId}/reversion

Revert Genomic Variant To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
genomicVariantId path string No

Response 201 Created

{
    "id": "12f07853-0eb4-4d4a-a492-39b8e3539187",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/autocomplete/gene-panels

Gell All Genomic Panels

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
query query string No

Response 200 OK

[
    "string"
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "type": "string"
    },
    "title": "Response",
    "type": "array"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Genomic Signatures


GET /api/v1/genomic-signatures

Get All Genomic Signatures Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
category query None No Category - Filter for single value choice
category.anyOf query array No Category - ('Filter for excluding a subset of value choices',)
category.not query None No Category - ('Filter for all but a single value choice',)
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        null
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/AnyGenomicSignature"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[AnyGenomicSignature]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/genomic-signatures

Create Genomic Signature

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/TumorMutationalBurdenCreate"
        },
        {
            "$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
        },
        {
            "$ref": "#/components/schemas/LossOfHeterozygosityCreate"
        },
        {
            "$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
        },
        {
            "$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
        },
        {
            "$ref": "#/components/schemas/AneuploidScoreCreate"
        }
    ],
    "title": "Payload"
}

Response 201 Created

{
    "id": "a38ed8ee-1560-45ee-8670-7091282506d8",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-signatures/{genomicSignatureId}

Get Genomic Signature By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
genomicSignatureId path string No

Response 200 OK

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/MicrosatelliteInstability"
        },
        {
            "$ref": "#/components/schemas/TumorMutationalBurden"
        },
        {
            "$ref": "#/components/schemas/LossOfHeterozygosity"
        },
        {
            "$ref": "#/components/schemas/HomologousRecombinationDeficiency"
        },
        {
            "$ref": "#/components/schemas/TumorNeoantigenBurden"
        },
        {
            "$ref": "#/components/schemas/AneuploidScore"
        }
    ]
}

Response 404 Not Found


PUT /api/v1/genomic-signatures/{genomicSignatureId}

Update Genomic Signature

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicSignatureId path string No

Request body

Schema of the request body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/TumorMutationalBurdenCreate"
        },
        {
            "$ref": "#/components/schemas/MicrosatelliteInstabilityCreate"
        },
        {
            "$ref": "#/components/schemas/LossOfHeterozygosityCreate"
        },
        {
            "$ref": "#/components/schemas/HomologousRecombinationDeficiencyCreate"
        },
        {
            "$ref": "#/components/schemas/TumorNeoantigenBurdenCreate"
        },
        {
            "$ref": "#/components/schemas/AneuploidScoreCreate"
        }
    ],
    "title": "Payload"
}

Response 200 OK

{
    "id": "9e532bcf-639d-465f-8491-e4c7d8331cdc",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/genomic-signatures/{genomicSignatureId}

Delete Genomic Signature

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicSignatureId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events

Get All Genomic Signature History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
genomicSignatureId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEvent"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}

Get Genomic Signature History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
genomicSignatureId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a history event within the system.\n\nAttributes:\n    id (Any): The unique identifier of the history event.\n    resourceId (Any): The unique identifier of the tracked resource.\n    category (HistoryEventCategory): The type of history event.\n    timestamp (datetime): Timestamp of the history event.\n    user (Nullable[str]): Username of the user that triggered the event, if applicable.\n    url (Nullable[str]): Endpoint URL through which the event was triggered, if applicable.\n    resource (Nullable[str]): Resource involved in the event, if applicable.\n    snapshot (Dict): Data snapshot at the time of the event.\n    differential (Nullable[Dict]): Data changes introduced by the event, if applicable.\n    context (Nullable[Dict]): Context surrounding the event.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEvent",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/genomic-signatures/{genomicSignatureId}/history/events/{eventId}/reversion

Revert Genomic Signature To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
genomicSignatureId path string No

Response 201 Created

{
    "id": "caa0e003-4c78-4003-986c-e5aa8fd96554",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Lifestyles


GET /api/v1/lifestyles

Get All Lifestyles Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
alcoholConsumption query string No Alcohol consumption - Filter for a matching concept code
alcoholConsumption.anyOf query array No Alcohol consumption - Filter for a matching set of concept codes
alcoholConsumption.descendantsOf query string No Alcohol consumption - Filter for all child concepts of a given concepts code
alcoholConsumption.exists query boolean No Alcohol consumption - Filter for entries with a value
alcoholConsumption.not query string No Alcohol consumption - Filter for a mismatching concept code
alcoholConsumption.not.anyOf query array No Alcohol consumption - Filter for a mismmatching set of concept codes
alcoholConsumption.not.exists query boolean No Alcohol consumption - Filter for entries without a value
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
exposures query string No Exposures - Filter for a matching concept code
exposures.allOf query array No Exposures - Filter for entries matching all of the concepts
exposures.anyOf query array No Exposures - Filter for a matching set of concept codes
exposures.descendantsOf query string No Exposures - Filter for all child concepts of a given concepts code
exposures.exists query boolean No Exposures - Filter for entries with a value
exposures.not query string No Exposures - Filter for a mismatching concept code
exposures.not.allOf query array No Exposures - Filter for entries mismatching all of the concepts
exposures.not.anyOf query array No Exposures - Filter for a mismmatching set of concept codes
exposures.not.exists query boolean No Exposures - Filter for entries without a value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
nightSleep.between query array No Night sleep - Filter for entries with values between two specified values (inclusive)
nightSleep.equal query number No Night sleep - Filter for entries with values exactly equal to the specified value
nightSleep.exists query boolean No Night sleep - Filter for entries with a value
nightSleep.greaterThan query number No Night sleep - Filter for entries with values greater than the specified value
nightSleep.greaterThanOrEqual query number No Night sleep - Filter for entries with values greater than or equal to the specified value
nightSleep.lessThan query number No Night sleep - Filter for entries with values less than the specified value
nightSleep.lessThanOrEqual query number No Night sleep - Filter for entries with values less than or equal to the specified value
nightSleep.not.between query array No Night sleep - Filter for entries with values between two specified values (inclusive)
nightSleep.not.equal query number No Night sleep - Filter for entries with values not equal to the specified value
nightSleep.not.exists query boolean No Night sleep - Filter for entries without a value
offset query integer 0 No
ordering query None No
recreationalDrugs query string No Recreational drugs - Filter for a matching concept code
recreationalDrugs.allOf query array No Recreational drugs - Filter for entries matching all of the concepts
recreationalDrugs.anyOf query array No Recreational drugs - Filter for a matching set of concept codes
recreationalDrugs.descendantsOf query string No Recreational drugs - Filter for all child concepts of a given concepts code
recreationalDrugs.exists query boolean No Recreational drugs - Filter for entries with a value
recreationalDrugs.not query string No Recreational drugs - Filter for a mismatching concept code
recreationalDrugs.not.allOf query array No Recreational drugs - Filter for entries mismatching all of the concepts
recreationalDrugs.not.anyOf query array No Recreational drugs - Filter for a mismmatching set of concept codes
recreationalDrugs.not.exists query boolean No Recreational drugs - Filter for entries without a value
smokingPackyears.between query array No Smoking packyears - Filter for entries with values between two specified values (inclusive)
smokingPackyears.equal query number No Smoking packyears - Filter for entries with values exactly equal to the specified value
smokingPackyears.exists query boolean No Smoking packyears - Filter for entries with a value
smokingPackyears.greaterThan query number No Smoking packyears - Filter for entries with values greater than the specified value
smokingPackyears.greaterThanOrEqual query number No Smoking packyears - Filter for entries with values greater than or equal to the specified value
smokingPackyears.lessThan query number No Smoking packyears - Filter for entries with values less than the specified value
smokingPackyears.lessThanOrEqual query number No Smoking packyears - Filter for entries with values less than or equal to the specified value
smokingPackyears.not.between query array No Smoking packyears - Filter for entries with values between two specified values (inclusive)
smokingPackyears.not.equal query number No Smoking packyears - Filter for entries with values not equal to the specified value
smokingPackyears.not.exists query boolean No Smoking packyears - Filter for entries without a value
smokingQuited.between query array No Time since quitted smoking - Filter for entries with values between two specified values (inclusive)
smokingQuited.equal query number No Time since quitted smoking - Filter for entries with values exactly equal to the specified value
smokingQuited.exists query boolean No Time since quitted smoking - Filter for entries with a value
smokingQuited.greaterThan query number No Time since quitted smoking - Filter for entries with values greater than the specified value
smokingQuited.greaterThanOrEqual query number No Time since quitted smoking - Filter for entries with values greater than or equal to the specified value
smokingQuited.lessThan query number No Time since quitted smoking - Filter for entries with values less than the specified value
smokingQuited.lessThanOrEqual query number No Time since quitted smoking - Filter for entries with values less than or equal to the specified value
smokingQuited.not.between query array No Time since quitted smoking - Filter for entries with values between two specified values (inclusive)
smokingQuited.not.equal query number No Time since quitted smoking - Filter for entries with values not equal to the specified value
smokingQuited.not.exists query boolean No Time since quitted smoking - Filter for entries without a value
smokingStatus query string No Smoking Status - Filter for a matching concept code
smokingStatus.anyOf query array No Smoking Status - Filter for a matching set of concept codes
smokingStatus.descendantsOf query string No Smoking Status - Filter for all child concepts of a given concepts code
smokingStatus.exists query boolean No Smoking Status - Filter for entries with a value
smokingStatus.not query string No Smoking Status - Filter for a mismatching concept code
smokingStatus.not.anyOf query array No Smoking Status - Filter for a mismmatching set of concept codes
smokingStatus.not.exists query boolean No Smoking Status - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "270dfe5a-8523-49a3-832e-bbaec817dcbf",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "71c68bcb-0a06-4a31-beb5-10f8fc452371",
            "date": "2022-04-13",
            "smokingStatus": null,
            "smokingPackyears": 10.12,
            "smokingQuited": null,
            "alcoholConsumption": null,
            "nightSleep": null,
            "recreationalDrugs": [
                {
                    "code": "string",
                    "system": "string",
                    "display": "string",
                    "version": "string",
                    "synonyms": [
                        "string"
                    ],
                    "properties": {}
                }
            ],
            "exposures": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Lifestyle"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Lifestyle]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/lifestyles

Create Lifestyle

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "cfb91e89-8279-4c2b-94fe-270e03ed4418",
    "date": "2022-04-13",
    "smokingStatus": null,
    "smokingPackyears": 10.12,
    "smokingQuited": null,
    "alcoholConsumption": null,
    "nightSleep": null,
    "recreationalDrugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "exposures": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's lifestyle is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "smokingStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Tobacco consumption status",
            "title": "Smoking Status",
            "x-terminology": "SmokingStatus"
        },
        "smokingPackyears": {
            "description": "Smoking pack-years (if applicable)",
            "title": "Smoking packyears",
            "type": "number"
        },
        "smokingQuited": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated time since quitting smoking (if applicable)",
            "title": "Time since quitted smoking",
            "x-default-unit": "year",
            "x-measure": "Time"
        },
        "alcoholConsumption": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Frequency of alcohol consumption",
            "title": "Alcohol consumption",
            "x-terminology": "AlcoholConsumptionFrequency"
        },
        "nightSleep": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated average sleep time per night",
            "title": "Night sleep",
            "x-default-unit": "hour",
            "x-measure": "Time"
        },
        "recreationalDrugs": {
            "description": "Any recreational drug(s) used by the patient",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Recreational drugs",
            "type": "array",
            "x-terminology": "RecreationalDrug"
        },
        "exposures": {
            "description": "Environmental or occupational exposures to hazards or carcinogenic agents",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Exposures",
            "type": "array",
            "x-terminology": "ExposureAgent"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "LifestyleCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "b2ec4a48-54fc-476f-b693-55de0d7c38a7",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/lifestyles/{lifestyleId}

Get Lifestyle By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
lifestyleId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "4b7d05f8-ae23-4d35-a06f-e6c470e19cbd",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "49da0739-12b4-4ba8-8607-a9fbbd11578e",
    "date": "2022-04-13",
    "smokingStatus": null,
    "smokingPackyears": 10.12,
    "smokingQuited": null,
    "alcoholConsumption": null,
    "nightSleep": null,
    "recreationalDrugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "exposures": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's lifestyle is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "smokingStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Tobacco consumption status",
            "title": "Smoking Status",
            "x-terminology": "SmokingStatus"
        },
        "smokingPackyears": {
            "description": "Smoking pack-years (if applicable)",
            "title": "Smoking packyears",
            "type": "number"
        },
        "smokingQuited": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated time since quitting smoking (if applicable)",
            "title": "Time since quitted smoking",
            "x-default-unit": "year",
            "x-measure": "Time"
        },
        "alcoholConsumption": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Frequency of alcohol consumption",
            "title": "Alcohol consumption",
            "x-terminology": "AlcoholConsumptionFrequency"
        },
        "nightSleep": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated average sleep time per night",
            "title": "Night sleep",
            "x-default-unit": "hour",
            "x-measure": "Time"
        },
        "recreationalDrugs": {
            "description": "Any recreational drug(s) used by the patient",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Recreational drugs",
            "type": "array",
            "x-terminology": "RecreationalDrug"
        },
        "exposures": {
            "description": "Environmental or occupational exposures to hazards or carcinogenic agents",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Exposures",
            "type": "array",
            "x-terminology": "ExposureAgent"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date"
    ],
    "title": "Lifestyle",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/lifestyles/{lifestyleId}

Update Lifestyle

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
lifestyleId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "d1c0530d-4f7f-4c52-b6f7-9e2218a9664c",
    "date": "2022-04-13",
    "smokingStatus": null,
    "smokingPackyears": 10.12,
    "smokingQuited": null,
    "alcoholConsumption": null,
    "nightSleep": null,
    "recreationalDrugs": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "exposures": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's lifestyle is assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's lifetyle was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "smokingStatus": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Tobacco consumption status",
            "title": "Smoking Status",
            "x-terminology": "SmokingStatus"
        },
        "smokingPackyears": {
            "description": "Smoking pack-years (if applicable)",
            "title": "Smoking packyears",
            "type": "number"
        },
        "smokingQuited": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated time since quitting smoking (if applicable)",
            "title": "Time since quitted smoking",
            "x-default-unit": "year",
            "x-measure": "Time"
        },
        "alcoholConsumption": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Frequency of alcohol consumption",
            "title": "Alcohol consumption",
            "x-terminology": "AlcoholConsumptionFrequency"
        },
        "nightSleep": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Estimated average sleep time per night",
            "title": "Night sleep",
            "x-default-unit": "hour",
            "x-measure": "Time"
        },
        "recreationalDrugs": {
            "description": "Any recreational drug(s) used by the patient",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Recreational drugs",
            "type": "array",
            "x-terminology": "RecreationalDrug"
        },
        "exposures": {
            "description": "Environmental or occupational exposures to hazards or carcinogenic agents",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Exposures",
            "type": "array",
            "x-terminology": "ExposureAgent"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "LifestyleCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "1300006a-83e0-4065-af68-c5f308a421cd",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/lifestyles/{lifestyleId}

Delete Lifestyle

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
lifestyleId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/lifestyles/{lifestyleId}/history/events

Get All Lifestyle History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
lifestyleId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}

Get Lifestyle History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
lifestyleId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/lifestyles/{lifestyleId}/history/events/{eventId}/reversion

Revert Lifestyle To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
lifestyleId path string No

Response 201 Created

{
    "id": "b7d7dab3-011f-465d-b119-6916a14db406",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Family Histories


GET /api/v1/family-histories

Get All Family Member Histories Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
contributedToDeath query boolean No Contributed to death - Filter for yes/no statement
contributedToDeath.exists query boolean No Contributed to death - Filter for entries with a value
contributedToDeath.not.exists query boolean No Contributed to death - Filter for entries without a value
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
hadCancer query boolean No Had cancer - Filter for yes/no statement
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
morphology query string No Morphology - Filter for a matching concept code
morphology.anyOf query array No Morphology - Filter for a matching set of concept codes
morphology.descendantsOf query string No Morphology - Filter for all child concepts of a given concepts code
morphology.exists query boolean No Morphology - Filter for entries with a value
morphology.not query string No Morphology - Filter for a mismatching concept code
morphology.not.anyOf query array No Morphology - Filter for a mismmatching set of concept codes
morphology.not.exists query boolean No Morphology - Filter for entries without a value
offset query integer 0 No
onsetAge.between query array No Onset age - Filter for entries with values between two specified values (inclusive)
onsetAge.equal query integer No Onset age - Filter for entries with values exactly equal to the specified value
onsetAge.exists query boolean No Onset age - Filter for entries with a value
onsetAge.greaterThan query integer No Onset age - Filter for entries with values greater than the specified value
onsetAge.greaterThanOrEqual query integer No Onset age - Filter for entries with values greater than or equal to the specified value
onsetAge.lessThan query integer No Onset age - Filter for entries with values less than the specified value
onsetAge.lessThanOrEqual query integer No Onset age - Filter for entries with values less than or equal to the specified value
onsetAge.not.between query array No Onset age - Filter for entries with values between two specified values (inclusive)
onsetAge.not.equal query integer No Onset age - Filter for entries with values not equal to the specified value
onsetAge.not.exists query boolean No Onset age - Filter for entries without a value
ordering query None No
relationship query string No Relationship - Filter for a matching concept code
relationship.anyOf query array No Relationship - Filter for a matching set of concept codes
relationship.descendantsOf query string No Relationship - Filter for all child concepts of a given concepts code
relationship.not query string No Relationship - Filter for a mismatching concept code
relationship.not.anyOf query array No Relationship - Filter for a mismmatching set of concept codes
topography query string No Topography - Filter for a matching concept code
topography.anyOf query array No Topography - Filter for a matching set of concept codes
topography.descendantsOf query string No Topography - Filter for all child concepts of a given concepts code
topography.exists query boolean No Topography - Filter for entries with a value
topography.not query string No Topography - Filter for a mismatching concept code
topography.not.anyOf query array No Topography - Filter for a mismmatching set of concept codes
topography.not.exists query boolean No Topography - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "ca6fb1e2-24a7-497a-a113-248623131e54",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "27923b60-7bb0-4023-a8ee-1552a4510445",
            "date": "2022-04-13",
            "relationship": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "hadCancer": true,
            "contributedToDeath": true,
            "onsetAge": 0,
            "topography": null,
            "morphology": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/FamilyHistory"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[FamilyHistory]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/family-histories

Create Family History

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "19d61fda-24ef-4005-9817-3ae3768ee9ce",
    "date": "2022-04-13",
    "relationship": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "hadCancer": true,
    "contributedToDeath": true,
    "onsetAge": 0,
    "topography": null,
    "morphology": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's family's history is being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Relationship to the patient",
            "title": "Relationship",
            "x-terminology": "FamilyMemberType"
        },
        "hadCancer": {
            "description": "Whether the family member has a history of cancer",
            "title": "Had cancer",
            "type": "boolean"
        },
        "contributedToDeath": {
            "description": "Whether the cancer contributed to the cause of death of the family member",
            "title": "Contributed to death",
            "type": "boolean"
        },
        "onsetAge": {
            "description": "Age at which the family member's cancer manifested",
            "title": "Onset age",
            "type": "integer"
        },
        "topography": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Estimated or actual topography of the family member's cancer",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the family member's cancer (if known)",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        }
    },
    "required": [
        "caseId",
        "date",
        "relationship",
        "hadCancer"
    ],
    "title": "FamilyHistoryCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "b41ef563-78a0-44bf-8e06-a95618ec2d7e",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/family-histories/{familyHistoryId}

Get Family History By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
familyHistoryId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "79d59332-ff18-4567-a65e-8fb7e3ad2849",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "c79fa662-a061-411c-8ad2-ff4cdd9cc947",
    "date": "2022-04-13",
    "relationship": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "hadCancer": true,
    "contributedToDeath": true,
    "onsetAge": 0,
    "topography": null,
    "morphology": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's family's history is being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Relationship to the patient",
            "title": "Relationship",
            "x-terminology": "FamilyMemberType"
        },
        "hadCancer": {
            "description": "Whether the family member has a history of cancer",
            "title": "Had cancer",
            "type": "boolean"
        },
        "contributedToDeath": {
            "description": "Whether the cancer contributed to the cause of death of the family member",
            "title": "Contributed to death",
            "type": "boolean"
        },
        "onsetAge": {
            "description": "Age at which the family member's cancer manifested",
            "title": "Onset age",
            "type": "integer"
        },
        "topography": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Estimated or actual topography of the family member's cancer",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the family member's cancer (if known)",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "relationship",
        "hadCancer"
    ],
    "title": "FamilyHistory",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/family-histories/{familyHistoryId}

Delete Family History

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
familyHistoryId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/family-histories/{familyHistoryId}

Update Family History

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
familyHistoryId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "5c5b1575-68ba-488e-bafb-bbb06685e6c3",
    "date": "2022-04-13",
    "relationship": {
        "code": "string",
        "system": "string",
        "display": "string",
        "version": "string",
        "synonyms": [
            "string"
        ],
        "properties": {}
    },
    "hadCancer": true,
    "contributedToDeath": true,
    "onsetAge": 0,
    "topography": null,
    "morphology": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's family's history is being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's family history was assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "relationship": {
            "$ref": "#/components/schemas/CodedConcept",
            "description": "Relationship to the patient",
            "title": "Relationship",
            "x-terminology": "FamilyMemberType"
        },
        "hadCancer": {
            "description": "Whether the family member has a history of cancer",
            "title": "Had cancer",
            "type": "boolean"
        },
        "contributedToDeath": {
            "description": "Whether the cancer contributed to the cause of death of the family member",
            "title": "Contributed to death",
            "type": "boolean"
        },
        "onsetAge": {
            "description": "Age at which the family member's cancer manifested",
            "title": "Onset age",
            "type": "integer"
        },
        "topography": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Estimated or actual topography of the family member's cancer",
            "title": "Topography",
            "x-terminology": "CancerTopography"
        },
        "morphology": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CodedConcept"
                }
            ],
            "description": "Morphology of the family member's cancer (if known)",
            "title": "Morphology",
            "x-terminology": "CancerMorphology"
        }
    },
    "required": [
        "caseId",
        "date",
        "relationship",
        "hadCancer"
    ],
    "title": "FamilyHistoryCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "11e3ff02-0412-4bfa-b953-16c0a8e5c650",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/family-histories/{familyHistoryId}/history/events

Get All Family History History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
familyHistoryId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}

Get Family History History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
familyHistoryId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/family-histories/{familyHistoryId}/history/events/{eventId}/reversion

Revert Family History To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
familyHistoryId path string No

Response 201 Created

{
    "id": "8a729e5a-6c1c-4fd3-b263-5d578307b8ea",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Comorbidities Assessments


GET /api/v1/comorbidities-assessments

Get All Comorbidities Assessments Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
absentConditions query string No Absent comorbid conditions - Filter for a matching concept code
absentConditions.allOf query array No Absent comorbid conditions - Filter for entries matching all of the concepts
absentConditions.anyOf query array No Absent comorbid conditions - Filter for a matching set of concept codes
absentConditions.descendantsOf query string No Absent comorbid conditions - Filter for all child concepts of a given concepts code
absentConditions.exists query boolean No Absent comorbid conditions - Filter for entries with a value
absentConditions.not query string No Absent comorbid conditions - Filter for a mismatching concept code
absentConditions.not.allOf query array No Absent comorbid conditions - Filter for entries mismatching all of the concepts
absentConditions.not.anyOf query array No Absent comorbid conditions - Filter for a mismmatching set of concept codes
absentConditions.not.exists query boolean No Absent comorbid conditions - Filter for entries without a value
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
indexConditionId query string No Index neoplastic entity - Filter for reference matches
indexConditionId.anyOf query array No Index neoplastic entity - Filter for entries where at least one reference matches the query
indexConditionId.beginsWith query string No Index neoplastic entity - Filter for entries starting with the text
indexConditionId.contains query string No Index neoplastic entity - Filter for partial text matches
indexConditionId.endsWith query string No Index neoplastic entity - Filter for entries ending with the text
indexConditionId.not query string No Index neoplastic entity - Filter for reference mismatches
indexConditionId.not.anyOf query array No Index neoplastic entity - Filter for entries where at least one reference mismatches the query
indexConditionId.not.beginsWith query string No Index neoplastic entity - Filter for entries not starting with the text
indexConditionId.not.contains query string No Index neoplastic entity - Filter for partial text mismatches
indexConditionId.not.endsWith query string No Index neoplastic entity - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
panel query None No Panel - Filter for single value choice
panel.anyOf query array No Panel - ('Filter for excluding a subset of value choices',)
panel.exists query boolean No Panel - Filter for entries with a value
panel.not query None No Panel - ('Filter for all but a single value choice',)
panel.not.exists query boolean No Panel - Filter for entries without a value
presentConditions query string No Present comorbid conditions - Filter for a matching concept code
presentConditions.allOf query array No Present comorbid conditions - Filter for entries matching all of the concepts
presentConditions.anyOf query array No Present comorbid conditions - Filter for a matching set of concept codes
presentConditions.descendantsOf query string No Present comorbid conditions - Filter for all child concepts of a given concepts code
presentConditions.exists query boolean No Present comorbid conditions - Filter for entries with a value
presentConditions.not query string No Present comorbid conditions - Filter for a mismatching concept code
presentConditions.not.allOf query array No Present comorbid conditions - Filter for entries mismatching all of the concepts
presentConditions.not.anyOf query array No Present comorbid conditions - Filter for a mismmatching set of concept codes
presentConditions.not.exists query boolean No Present comorbid conditions - Filter for entries without a value
score.between query array No Score - Filter for entries with values between two specified values (inclusive)
score.equal query integer No Score - Filter for entries with values exactly equal to the specified value
score.exists query boolean No Score - Filter for entries with a value
score.greaterThan query integer No Score - Filter for entries with values greater than the specified value
score.greaterThanOrEqual query integer No Score - Filter for entries with values greater than or equal to the specified value
score.lessThan query integer No Score - Filter for entries with values less than the specified value
score.lessThanOrEqual query integer No Score - Filter for entries with values less than or equal to the specified value
score.not.between query array No Score - Filter for entries with values between two specified values (inclusive)
score.not.equal query integer No Score - Filter for entries with values not equal to the specified value
score.not.exists query boolean No Score - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "6c09c27f-af5c-4758-8cac-aaa0268d41c0",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "ff4bebc4-917a-4aee-9c9e-0fcc02832df2",
            "date": "2022-04-13",
            "indexConditionId": "aa79327f-8245-4113-876f-54a7f142687e",
            "panel": null,
            "presentConditions": [
                {
                    "code": "string",
                    "system": "string",
                    "display": "string",
                    "version": "string",
                    "synonyms": [
                        "string"
                    ],
                    "properties": {}
                }
            ],
            "absentConditions": null,
            "score": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/ComorbiditiesAssessment"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[ComorbiditiesAssessment]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/comorbidities-assessments

Create Comorbidities Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "812ce9a9-7bb8-4c1e-ac60-2dd5998807c6",
    "date": "2022-04-13",
    "indexConditionId": "779355cb-fa09-40b7-a01a-7aa020fd45f5",
    "panel": null,
    "presentConditions": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "absentConditions": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's comorbidities are being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "indexConditionId": {
            "description": "The primary neoplastic entity against which comorbidities are assessed",
            "format": "uuid",
            "title": "Index neoplastic entity",
            "type": "string"
        },
        "panel": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
                }
            ],
            "description": "Comorbidities panel",
            "title": "Panel"
        },
        "presentConditions": {
            "description": "Present comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Present comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        },
        "absentConditions": {
            "description": "Absent comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Absent comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        }
    },
    "required": [
        "caseId",
        "date",
        "indexConditionId"
    ],
    "title": "ComorbiditiesAssessmentCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "7e5d492e-d64f-4a90-ad9e-823a866521b5",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}

Get Comorbidities Assessment By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
comorbiditiesAssessmentId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "da466537-43aa-47f2-b2ba-d5015f02547e",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "b3be67f3-01aa-485b-a61b-3168f3d2169b",
    "date": "2022-04-13",
    "indexConditionId": "b84e08a0-0811-43af-a265-11d6d1af19f5",
    "panel": null,
    "presentConditions": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "absentConditions": null,
    "score": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's comorbidities are being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "indexConditionId": {
            "description": "The primary neoplastic entity against which comorbidities are assessed",
            "format": "uuid",
            "title": "Index neoplastic entity",
            "type": "string"
        },
        "panel": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
                }
            ],
            "description": "Comorbidities panel",
            "title": "Panel"
        },
        "presentConditions": {
            "description": "Present comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Present comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        },
        "absentConditions": {
            "description": "Absent comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Absent comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        },
        "score": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "number"
                }
            ],
            "description": "Comorbidity score",
            "title": "Score"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date",
        "indexConditionId"
    ],
    "title": "ComorbiditiesAssessment",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}

Delete Comorbidities Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
comorbiditiesAssessmentId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}

Update Comorbidities Assessment

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
comorbiditiesAssessmentId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "e9c9d438-8c1f-4311-a226-ec9e272bb318",
    "date": "2022-04-13",
    "indexConditionId": "0ccf732f-a722-4b95-8211-12c76e02acc6",
    "panel": null,
    "presentConditions": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ],
    "absentConditions": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's comorbidities are being recorded",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the patient's comorbidities were assessed and recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "indexConditionId": {
            "description": "The primary neoplastic entity against which comorbidities are assessed",
            "format": "uuid",
            "title": "Index neoplastic entity",
            "type": "string"
        },
        "panel": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ComorbiditiesAssessmentPanelChoices"
                }
            ],
            "description": "Comorbidities panel",
            "title": "Panel"
        },
        "presentConditions": {
            "description": "Present comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Present comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        },
        "absentConditions": {
            "description": "Absent comorbid conditions",
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Absent comorbid conditions",
            "type": "array",
            "x-terminology": "ICD10Condition"
        }
    },
    "required": [
        "caseId",
        "date",
        "indexConditionId"
    ],
    "title": "ComorbiditiesAssessmentCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "ab7db7cd-5ac7-49a7-ab6e-300eac6761c3",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events

Get All Comorbidities Assessment History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
comorbiditiesAssessmentId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}

Get Comorbidities Assessment History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
comorbiditiesAssessmentId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/comorbidities-assessments/{comorbiditiesAssessmentId}/history/events/{eventId}/reversion

Revert Comorbidities Assessment To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
comorbiditiesAssessmentId path string No
eventId path string No

Response 201 Created

{
    "id": "d368bccd-743a-48d1-aa38-fd268da880aa",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/comorbidities-assessments/meta/panels

Get All Comorbidities Panels

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Response 200 OK

[
    {
        "name": "string",
        "categories": [
            {
                "label": "string",
                "default": null,
                "conditions": [
                    {
                        "code": "string",
                        "system": "string",
                        "display": "string",
                        "version": "string",
                        "synonyms": [
                            "string"
                        ],
                        "properties": {}
                    }
                ]
            }
        ]
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/ComorbiditiesPanel"
    },
    "title": "Response",
    "type": "array"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/comorbidities-assessments/meta/panels/{panel}

Get Comorbidities Panel By Name

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
panel path string No An enumeration of comorbidity panel types used in oncology models. Attributes: CHARLSON: Represents the Charlson comorbidity index panel. ELIXHAUSER: Represents the Elixhauser comorbidity index panel. NCI: Represents the National Cancer Institute (NCI) comorbidity index panel.

Response 200 OK

{
    "name": "string",
    "categories": [
        {
            "label": "string",
            "default": null,
            "conditions": [
                {
                    "code": "string",
                    "system": "string",
                    "display": "string",
                    "version": "string",
                    "synonyms": [
                        "string"
                    ],
                    "properties": {}
                }
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "name": {
            "description": "Comorbidity panel name",
            "title": "Name",
            "type": "string"
        },
        "categories": {
            "description": "Comorbidity panel categories",
            "items": {
                "$ref": "#/components/schemas/ComorbidityPanelCategory"
            },
            "title": "Categories",
            "type": "array"
        }
    },
    "required": [
        "name",
        "categories"
    ],
    "title": "ComorbiditiesPanel",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Vitals


GET /api/v1/vitals

Get All Vitals Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
bloodPressureDiastolic.between query array No Diastolic blood pressure - Filter for entries with values between two specified values (inclusive)
bloodPressureDiastolic.equal query number No Diastolic blood pressure - Filter for entries with values exactly equal to the specified value
bloodPressureDiastolic.exists query boolean No Diastolic blood pressure - Filter for entries with a value
bloodPressureDiastolic.greaterThan query number No Diastolic blood pressure - Filter for entries with values greater than the specified value
bloodPressureDiastolic.greaterThanOrEqual query number No Diastolic blood pressure - Filter for entries with values greater than or equal to the specified value
bloodPressureDiastolic.lessThan query number No Diastolic blood pressure - Filter for entries with values less than the specified value
bloodPressureDiastolic.lessThanOrEqual query number No Diastolic blood pressure - Filter for entries with values less than or equal to the specified value
bloodPressureDiastolic.not.between query array No Diastolic blood pressure - Filter for entries with values between two specified values (inclusive)
bloodPressureDiastolic.not.equal query number No Diastolic blood pressure - Filter for entries with values not equal to the specified value
bloodPressureDiastolic.not.exists query boolean No Diastolic blood pressure - Filter for entries without a value
bloodPressureSystolic.between query array No Systolic blood pressure - Filter for entries with values between two specified values (inclusive)
bloodPressureSystolic.equal query number No Systolic blood pressure - Filter for entries with values exactly equal to the specified value
bloodPressureSystolic.exists query boolean No Systolic blood pressure - Filter for entries with a value
bloodPressureSystolic.greaterThan query number No Systolic blood pressure - Filter for entries with values greater than the specified value
bloodPressureSystolic.greaterThanOrEqual query number No Systolic blood pressure - Filter for entries with values greater than or equal to the specified value
bloodPressureSystolic.lessThan query number No Systolic blood pressure - Filter for entries with values less than the specified value
bloodPressureSystolic.lessThanOrEqual query number No Systolic blood pressure - Filter for entries with values less than or equal to the specified value
bloodPressureSystolic.not.between query array No Systolic blood pressure - Filter for entries with values between two specified values (inclusive)
bloodPressureSystolic.not.equal query number No Systolic blood pressure - Filter for entries with values not equal to the specified value
bloodPressureSystolic.not.exists query boolean No Systolic blood pressure - Filter for entries without a value
bodyMassIndex.between query array No Body mass index - Filter for entries with values between two specified values (inclusive)
bodyMassIndex.equal query number No Body mass index - Filter for entries with values exactly equal to the specified value
bodyMassIndex.exists query boolean No Body mass index - Filter for entries with a value
bodyMassIndex.greaterThan query number No Body mass index - Filter for entries with values greater than the specified value
bodyMassIndex.greaterThanOrEqual query number No Body mass index - Filter for entries with values greater than or equal to the specified value
bodyMassIndex.lessThan query number No Body mass index - Filter for entries with values less than the specified value
bodyMassIndex.lessThanOrEqual query number No Body mass index - Filter for entries with values less than or equal to the specified value
bodyMassIndex.not.between query array No Body mass index - Filter for entries with values between two specified values (inclusive)
bodyMassIndex.not.equal query number No Body mass index - Filter for entries with values not equal to the specified value
bodyMassIndex.not.exists query boolean No Body mass index - Filter for entries without a value
caseId query string No Patient case - Filter for reference matches
caseId.anyOf query array No Patient case - Filter for entries where at least one reference matches the query
caseId.beginsWith query string No Patient case - Filter for entries starting with the text
caseId.contains query string No Patient case - Filter for partial text matches
caseId.endsWith query string No Patient case - Filter for entries ending with the text
caseId.not query string No Patient case - Filter for reference mismatches
caseId.not.anyOf query array No Patient case - Filter for entries where at least one reference mismatches the query
caseId.not.beginsWith query string No Patient case - Filter for entries not starting with the text
caseId.not.contains query string No Patient case - Filter for partial text mismatches
caseId.not.endsWith query string No Patient case - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
date.after query string No Assessment date - Filter for entries with dates after the specified value
date.before query string No Assessment date - Filter for entries with dates before the specified value
date.between query array No Assessment date - Filter for entries with dates between two specified values (inclusive)
date.not.between query array No Assessment date - Filter for entries with dates not between two specified values (inclusive)
date.not.on query string No Assessment date - Filter for entries with dates not matching the specified value
date.on query string No Assessment date - Filter for entries with dates exactly matching the specified value
date.onOrAfter query string No Assessment date - Filter for entries with dates on or after the specified value
date.onOrBefore query string No Assessment date - Filter for entries with dates on or before the specified value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
height.between query array No Height - Filter for entries with values between two specified values (inclusive)
height.equal query number No Height - Filter for entries with values exactly equal to the specified value
height.exists query boolean No Height - Filter for entries with a value
height.greaterThan query number No Height - Filter for entries with values greater than the specified value
height.greaterThanOrEqual query number No Height - Filter for entries with values greater than or equal to the specified value
height.lessThan query number No Height - Filter for entries with values less than the specified value
height.lessThanOrEqual query number No Height - Filter for entries with values less than or equal to the specified value
height.not.between query array No Height - Filter for entries with values between two specified values (inclusive)
height.not.equal query number No Height - Filter for entries with values not equal to the specified value
height.not.exists query boolean No Height - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
limit query integer 10 No
offset query integer 0 No
ordering query None No
temperature.between query array No Temperature - Filter for entries with values between two specified values (inclusive)
temperature.equal query number No Temperature - Filter for entries with values exactly equal to the specified value
temperature.exists query boolean No Temperature - Filter for entries with a value
temperature.greaterThan query number No Temperature - Filter for entries with values greater than the specified value
temperature.greaterThanOrEqual query number No Temperature - Filter for entries with values greater than or equal to the specified value
temperature.lessThan query number No Temperature - Filter for entries with values less than the specified value
temperature.lessThanOrEqual query number No Temperature - Filter for entries with values less than or equal to the specified value
temperature.not.between query array No Temperature - Filter for entries with values between two specified values (inclusive)
temperature.not.equal query number No Temperature - Filter for entries with values not equal to the specified value
temperature.not.exists query boolean No Temperature - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value
weight.between query array No Weight - Filter for entries with values between two specified values (inclusive)
weight.equal query number No Weight - Filter for entries with values exactly equal to the specified value
weight.exists query boolean No Weight - Filter for entries with a value
weight.greaterThan query number No Weight - Filter for entries with values greater than the specified value
weight.greaterThanOrEqual query number No Weight - Filter for entries with values greater than or equal to the specified value
weight.lessThan query number No Weight - Filter for entries with values less than the specified value
weight.lessThanOrEqual query number No Weight - Filter for entries with values less than or equal to the specified value
weight.not.between query array No Weight - Filter for entries with values between two specified values (inclusive)
weight.not.equal query number No Weight - Filter for entries with values not equal to the specified value
weight.not.exists query boolean No Weight - Filter for entries without a value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "11a6ef35-2648-4b4a-bf81-26e19408763a",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "caseId": "c1a5c0b1-6616-44df-ae67-ce9fcbce25fd",
            "date": "2022-04-13",
            "height": null,
            "weight": null,
            "bloodPressureSystolic": null,
            "bloodPressureDiastolic": null,
            "temperature": null,
            "bodyMassIndex": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Vitals"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Vitals]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/vitals

Create Vitals

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "6c2f8677-6dc3-4bb0-ac1d-157ddd29bd33",
    "date": "2022-04-13",
    "height": null,
    "weight": null,
    "bloodPressureSystolic": null,
    "bloodPressureDiastolic": null,
    "temperature": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's vitals are assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the vitals were recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "height": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Height of the patient",
            "title": "Height",
            "x-default-unit": "m",
            "x-measure": "Distance"
        },
        "weight": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Weight of the patient",
            "title": "Weight",
            "x-default-unit": "kg",
            "x-measure": "Mass"
        },
        "bloodPressureSystolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Systolic blood pressure of the patient",
            "title": "Systolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "bloodPressureDiastolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Diastolic blood pressure of the patient",
            "title": "Diastolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "temperature": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Temperature of the patient",
            "title": "Temperature",
            "x-default-unit": "celsius",
            "x-measure": "Temperature"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "VitalsCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "0fac66a9-3ec6-4303-83cd-5ef56c20120e",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/vitals/{vitalsId}

Get Vitals By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
vitalsId path string No

Response 200 OK

{
    "anonymized": true,
    "id": "a0ce53a6-915e-4c4f-a13d-c71eaad53b29",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "362ba102-d7a6-4421-a032-54b5faea25f0",
    "date": "2022-04-13",
    "height": null,
    "weight": null,
    "bloodPressureSystolic": null,
    "bloodPressureDiastolic": null,
    "temperature": null,
    "bodyMassIndex": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "anonymized": {
            "default": false,
            "description": "Whether the data has been anonymized",
            "title": "Is anonymized",
            "type": "boolean"
        },
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's vitals are assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the vitals were recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "height": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Height of the patient",
            "title": "Height",
            "x-default-unit": "m",
            "x-measure": "Distance"
        },
        "weight": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Weight of the patient",
            "title": "Weight",
            "x-default-unit": "kg",
            "x-measure": "Mass"
        },
        "bloodPressureSystolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Systolic blood pressure of the patient",
            "title": "Systolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "bloodPressureDiastolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Diastolic blood pressure of the patient",
            "title": "Diastolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "temperature": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Temperature of the patient",
            "title": "Temperature",
            "x-default-unit": "celsius",
            "x-measure": "Temperature"
        },
        "bodyMassIndex": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Bodymass index of the patient",
            "title": "Body mass index",
            "x-measure": "MassPerArea"
        }
    },
    "required": [
        "id",
        "description",
        "caseId",
        "date"
    ],
    "title": "Vitals",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/vitals/{vitalsId}

Update Vitals

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
vitalsId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "caseId": "338b8232-aef6-4e8c-9a9c-f4232ed51eee",
    "date": "2022-04-13",
    "height": null,
    "weight": null,
    "bloodPressureSystolic": null,
    "bloodPressureDiastolic": null,
    "temperature": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "caseId": {
            "description": "Indicates the case of the patient who's vitals are assesed",
            "format": "uuid",
            "title": "Patient case",
            "type": "string"
        },
        "date": {
            "description": "Clinically-relevant date at which the vitals were recorded.",
            "format": "date",
            "title": "Assessment date",
            "type": "string"
        },
        "height": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Height of the patient",
            "title": "Height",
            "x-default-unit": "m",
            "x-measure": "Distance"
        },
        "weight": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Weight of the patient",
            "title": "Weight",
            "x-default-unit": "kg",
            "x-measure": "Mass"
        },
        "bloodPressureSystolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Systolic blood pressure of the patient",
            "title": "Systolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "bloodPressureDiastolic": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Diastolic blood pressure of the patient",
            "title": "Diastolic blood pressure",
            "x-default-unit": "mmHg",
            "x-measure": "Pressure"
        },
        "temperature": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Measure"
                }
            ],
            "description": "Temperature of the patient",
            "title": "Temperature",
            "x-default-unit": "celsius",
            "x-measure": "Temperature"
        }
    },
    "required": [
        "caseId",
        "date"
    ],
    "title": "VitalsCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "caacad0b-e773-4886-ba90-9e7b0f889b84",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/vitals/{vitalsId}

Delete Vitals

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
vitalsId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/vitals/{vitalsId}/history/events

Get All Vitals History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
limit query integer 10 No
offset query integer 0 No
ordering query None No
vitalsId path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/vitals/{vitalsId}/history/events/{eventId}

Get Vitals History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
vitalsId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/vitals/{vitalsId}/history/events/{eventId}/reversion

Revert Vitals To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
eventId path string No
vitalsId path string No

Response 201 Created

{
    "id": "9882f7e1-dae0-45ae-b753-a2871b710a6a",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Measures


GET /api/v1/measures/{measureName}/units

Get Measure Units

Description

Retrieves the available units for a specified measure.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
measureName path string No

Response 200 OK

[
    "string"
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "type": "string"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found


GET /api/v1/measures/{measureName}/units/default

Get Measure Default Units

Description

Retrieves the default unit for a specified measure.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
measureName path string No

Response 200 OK

"string"
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "Response",
    "type": "string"
}

Response 404 Not Found


POST /api/v1/measures/{measureName}/units/conversion

Convert Units

Description

Converts a measurement from one unit to another using the specified measure class.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
measureName path string No

Request body

{
    "value": 10.12,
    "unit": "string",
    "newUnit": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Represents a measure value and its intended conversion to a new unit.\n\nAttributes:\n    value (float): The numerical value of the measure.\n    unit (str): The unit of the measure.\n    newUnit (str): The new unit to convert the measure to.",
    "properties": {
        "value": {
            "description": "The numerical value of the measure to be converted.",
            "title": "Value",
            "type": "number"
        },
        "unit": {
            "description": "The current unit of the measure.",
            "title": "Original Unit",
            "type": "string"
        },
        "newUnit": {
            "description": "The target unit to convert the measure into.",
            "title": "New Unit",
            "type": "string"
        }
    },
    "required": [
        "value",
        "unit",
        "newUnit"
    ],
    "title": "MeasureConversion",
    "type": "object"
}

Response 200 OK

{
    "value": 10.12,
    "unit": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a measurable quantity with its value and unit.\n\nAttributes:\n    value (float): The numerical value of the measure.\n    unit (str): The unit in which the value is expressed.",
    "properties": {
        "value": {
            "description": "The numerical value of the measure.",
            "title": "Value",
            "type": "number"
        },
        "unit": {
            "description": "The unit of measurement (e.g., 'kg', 'm', 'ml').",
            "title": "Unit",
            "type": "string"
        }
    },
    "required": [
        "value",
        "unit"
    ],
    "title": "Measure",
    "type": "object"
}

Response 404 Not Found

Terminology


GET /api/v1/terminologies/{terminologyName}/concepts

Get Terminology Concepts

Description

Retrieves terminology concepts from the specified terminology, applying optional filters and search criteria.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
codes query None No
limit query integer 10 No
offset query integer 0 No
query query None No
terminologyName path string No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "code": "string",
            "system": "string",
            "display": "string",
            "version": "string",
            "synonyms": [
                "string"
            ],
            "properties": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/CodedConcept"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[CodedConcept]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Cohorts


GET /api/v1/cohorts

Get All Cohorts Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
casesIds query string No Cases - Filter for full text matches
casesIds.anyOf query array No Cases - Filter for entries where at least one reference matches the query
casesIds.beginsWith query string No Cases - Filter for entries starting with the text
casesIds.contains query string No Cases - Filter for partial text matches
casesIds.endsWith query string No Cases - Filter for entries ending with the text
casesIds.exists query boolean No Cases - Filter for entries with a value
casesIds.not query string No Cases - Filter for full text mismatches
casesIds.not.anyOf query array No Cases - Filter for entries where at least one reference mismatches the query
casesIds.not.beginsWith query string No Cases - Filter for entries not starting with the text
casesIds.not.contains query string No Cases - Filter for partial text mismatches
casesIds.not.endsWith query string No Cases - Filter for entries not ending with the text
casesIds.not.exists query boolean No Cases - Filter for entries without a value
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
createdBy query string No Filter for a particular cohort creator by its username
excludeCriteria.exists query boolean No Exclusion critera - Filter for entries with a value
excludeCriteria.not.exists query boolean No Exclusion critera - Filter for entries without a value
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
frozenSetIds query string No Frozen cases - Filter for full text matches
frozenSetIds.anyOf query array No Frozen cases - Filter for entries where at least one reference matches the query
frozenSetIds.beginsWith query string No Frozen cases - Filter for entries starting with the text
frozenSetIds.contains query string No Frozen cases - Filter for partial text matches
frozenSetIds.endsWith query string No Frozen cases - Filter for entries ending with the text
frozenSetIds.exists query boolean No Frozen cases - Filter for entries with a value
frozenSetIds.not query string No Frozen cases - Filter for full text mismatches
frozenSetIds.not.anyOf query array No Frozen cases - Filter for entries where at least one reference mismatches the query
frozenSetIds.not.beginsWith query string No Frozen cases - Filter for entries not starting with the text
frozenSetIds.not.contains query string No Frozen cases - Filter for partial text mismatches
frozenSetIds.not.endsWith query string No Frozen cases - Filter for entries not ending with the text
frozenSetIds.not.exists query boolean No Frozen cases - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
includeCriteria.exists query boolean No Inclusion critera - Filter for entries with a value
includeCriteria.not.exists query boolean No Inclusion critera - Filter for entries without a value
limit query integer 10 No
manualChoicesIds query string No Manually added cases - Filter for full text matches
manualChoicesIds.anyOf query array No Manually added cases - Filter for entries where at least one reference matches the query
manualChoicesIds.beginsWith query string No Manually added cases - Filter for entries starting with the text
manualChoicesIds.contains query string No Manually added cases - Filter for partial text matches
manualChoicesIds.endsWith query string No Manually added cases - Filter for entries ending with the text
manualChoicesIds.exists query boolean No Manually added cases - Filter for entries with a value
manualChoicesIds.not query string No Manually added cases - Filter for full text mismatches
manualChoicesIds.not.anyOf query array No Manually added cases - Filter for entries where at least one reference mismatches the query
manualChoicesIds.not.beginsWith query string No Manually added cases - Filter for entries not starting with the text
manualChoicesIds.not.contains query string No Manually added cases - Filter for partial text mismatches
manualChoicesIds.not.endsWith query string No Manually added cases - Filter for entries not ending with the text
manualChoicesIds.not.exists query boolean No Manually added cases - Filter for entries without a value
name query string No Cohort name - Filter for full text matches
name.anyOf query array No Cohort name - Filter for entries where at least one reference matches the query
name.beginsWith query string No Cohort name - Filter for entries starting with the text
name.contains query string No Cohort name - Filter for partial text matches
name.endsWith query string No Cohort name - Filter for entries ending with the text
name.not query string No Cohort name - Filter for full text mismatches
name.not.anyOf query array No Cohort name - Filter for entries where at least one reference mismatches the query
name.not.beginsWith query string No Cohort name - Filter for entries not starting with the text
name.not.contains query string No Cohort name - Filter for partial text mismatches
name.not.endsWith query string No Cohort name - Filter for entries not ending with the text
offset query integer 0 No
ordering query None No
population.between query array No Population - Filter for entries with values between two specified values (inclusive)
population.equal query integer No Population - Filter for entries with values exactly equal to the specified value
population.greaterThan query integer No Population - Filter for entries with values greater than the specified value
population.greaterThanOrEqual query integer No Population - Filter for entries with values greater than or equal to the specified value
population.lessThan query integer No Population - Filter for entries with values less than the specified value
population.lessThanOrEqual query integer No Population - Filter for entries with values less than or equal to the specified value
population.not.between query array No Population - Filter for entries with values between two specified values (inclusive)
population.not.equal query integer No Population - Filter for entries with values not equal to the specified value
projectId query string No Project - Filter for reference matches
projectId.anyOf query array No Project - Filter for entries where at least one reference matches the query
projectId.beginsWith query string No Project - Filter for entries starting with the text
projectId.contains query string No Project - Filter for partial text matches
projectId.endsWith query string No Project - Filter for entries ending with the text
projectId.exists query boolean No Project - Filter for entries with a value
projectId.not query string No Project - Filter for reference mismatches
projectId.not.anyOf query array No Project - Filter for entries where at least one reference mismatches the query
projectId.not.beginsWith query string No Project - Filter for entries not starting with the text
projectId.not.contains query string No Project - Filter for partial text mismatches
projectId.not.endsWith query string No Project - Filter for entries not ending with the text
projectId.not.exists query boolean No Project - Filter for entries without a value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": "c4301905-f5f2-4220-8fc7-ec578ea7943d",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "name": "string",
            "projectId": "3f6fe127-452a-45cc-b540-76de4be7fafa",
            "casesIds": [
                "9dbdfd29-6c53-4e64-9212-17f9409e72ac"
            ],
            "includeCriteria": null,
            "excludeCriteria": null,
            "manualChoicesIds": [
                "3f0f0bd5-bdf8-4705-8d10-7040c8c293af"
            ],
            "frozenSetIds": [
                "a161db4f-0276-470f-9be9-c4d9a798a07c"
            ],
            "population": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Cohort"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Cohort]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/cohorts

Create Cohort

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "projectId": "b8a1ece9-4e1f-4622-a743-67fc1f9565bb",
    "casesIds": [
        "c33c3d56-dd73-468a-9f81-61eb68e0bf9e"
    ],
    "includeCriteria": null,
    "excludeCriteria": null,
    "manualChoicesIds": [
        "69499c06-3ca9-487e-98d5-e7902fa5225c"
    ],
    "frozenSetIds": [
        "83921259-1e2e-435d-8edc-be8785465ad5"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the cohort",
            "maxLength": 255,
            "title": "Cohort name",
            "type": "string"
        },
        "projectId": {
            "description": "Project to which the cohort is associated",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        },
        "casesIds": {
            "description": "Cases composing the cohort",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Cases",
            "type": "array"
        },
        "includeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be included in the cohort",
            "title": "Inclusion critera"
        },
        "excludeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
            "title": "Exclusion critera"
        },
        "manualChoicesIds": {
            "description": "Manually added cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Manually added cases",
            "type": "array"
        },
        "frozenSetIds": {
            "description": "Frozen cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Frozen cases",
            "type": "array"
        }
    },
    "required": [
        "name"
    ],
    "title": "CohortCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "ca7a1524-781f-473c-9692-fec8fea9c378",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}

Get Cohort By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Response 200 OK

{
    "id": "a1d766e3-c11a-489b-9304-caac2b2eb90d",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "projectId": "cf725b16-cda1-4b82-be7e-43b5c52441cc",
    "casesIds": [
        "dab18eab-bc40-4512-9fba-bb05a1c743e8"
    ],
    "includeCriteria": null,
    "excludeCriteria": null,
    "manualChoicesIds": [
        "9fd5b73e-ed7a-4553-9741-84bde514077f"
    ],
    "frozenSetIds": [
        "929517df-21f6-416d-abad-e979a93bf652"
    ],
    "population": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the cohort",
            "maxLength": 255,
            "title": "Cohort name",
            "type": "string"
        },
        "projectId": {
            "description": "Project to which the cohort is associated",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        },
        "casesIds": {
            "description": "Cases composing the cohort",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Cases",
            "type": "array"
        },
        "includeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be included in the cohort",
            "title": "Inclusion critera"
        },
        "excludeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
            "title": "Exclusion critera"
        },
        "manualChoicesIds": {
            "description": "Manually added cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Manually added cases",
            "type": "array"
        },
        "frozenSetIds": {
            "description": "Frozen cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Frozen cases",
            "type": "array"
        },
        "population": {
            "description": "Cohort population",
            "title": "Population",
            "type": "integer"
        }
    },
    "required": [
        "id",
        "description",
        "name",
        "population"
    ],
    "title": "Cohort",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/cohorts/{cohortId}

Delete Cohort

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/cohorts/{cohortId}

Update Cohort

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Request body

{
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "projectId": "ef7c54e7-010a-45ce-ab10-19604a000e69",
    "casesIds": [
        "9fe670cf-5121-4c6a-a82d-b47d7c1c4e47"
    ],
    "includeCriteria": null,
    "excludeCriteria": null,
    "manualChoicesIds": [
        "3c9089eb-e468-453d-9e7c-c5351adc6cfb"
    ],
    "frozenSetIds": [
        "270b2fdb-da23-485b-ac72-3833de6b566b"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the cohort",
            "maxLength": 255,
            "title": "Cohort name",
            "type": "string"
        },
        "projectId": {
            "description": "Project to which the cohort is associated",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        },
        "casesIds": {
            "description": "Cases composing the cohort",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Cases",
            "type": "array"
        },
        "includeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be included in the cohort",
            "title": "Inclusion critera"
        },
        "excludeCriteria": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CohortRuleset"
                }
            ],
            "description": "Logic rules to filter and constrain the cases to be excluded from the cohort",
            "title": "Exclusion critera"
        },
        "manualChoicesIds": {
            "description": "Manually added cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Manually added cases",
            "type": "array"
        },
        "frozenSetIds": {
            "description": "Frozen cases",
            "items": {
                "format": "uuid",
                "type": "string"
            },
            "title": "Frozen cases",
            "type": "array"
        }
    },
    "required": [
        "name"
    ],
    "title": "CohortCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "8f8a5e35-62a4-4628-b4e5-923545e4be56",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/cases

Get Cohort Cases

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
anonymized query boolean True No Whether to anonymize the data or not (requires elevated permissions)
cohortId path string No
limit query integer 10 No
offset query integer 0 No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "5b350759-3f30-47b0-8581-22885521a3d1",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "clinicalCenter": "string",
            "clinicalIdentifier": "string",
            "consentStatus": null,
            "gender": {
                "code": "string",
                "system": "string",
                "display": "string",
                "version": "string",
                "synonyms": [
                    "string"
                ],
                "properties": {}
            },
            "race": null,
            "sexAtBirth": null,
            "genderIdentity": null,
            "dateOfBirth": null,
            "vitalStatus": null,
            "dateOfDeath": "2022-04-13",
            "causeOfDeath": null,
            "endOfRecords": "2022-04-13",
            "pseudoidentifier": "string",
            "age": null,
            "overallSurvival": 10.12,
            "ageAtDiagnosis": null,
            "dataCompletionRate": 10.12,
            "contributors": [
                "string"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/PatientCase"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[PatientCase]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/contributors

Get Cohort Contributions

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
limit query integer 10 No
offset query integer 0 No

Response 200 OK

[
    {
        "contributor": "string",
        "contributions": 0
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/CohortContribution"
    },
    "title": "Response",
    "type": "array"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/cohorts/{cohortId}/export

Export Cohort Definition

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Response 200 OK

{
    "exportedAt": "2022-04-13T15:42:05.901Z",
    "exportedBy": "string",
    "exportVersion": "string",
    "checksum": "string",
    "definition": {
        "externalSource": "string",
        "externalSourceId": "string",
        "name": "string",
        "projectId": "b95ffc15-e89e-431e-8efd-1d7fd53b96b5",
        "casesIds": [
            "385b388c-a31a-4468-ba96-338d39d99b36"
        ],
        "includeCriteria": null,
        "excludeCriteria": null,
        "manualChoicesIds": [
            "e500458f-596f-4a58-a27d-86298b67d462"
        ],
        "frozenSetIds": [
            "e955c6ab-cbf7-4b3c-89d4-23e62f5f4f65"
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents an exported cohort definition along with its export metadata.\n\nAttributes:\n    definition (CohortCreateSchema): The cohort definition, including its title and description.",
    "properties": {
        "exportedAt": {
            "description": "The datetime when the resource was exported.",
            "format": "date-time",
            "title": "Export Timestamp",
            "type": "string"
        },
        "exportedBy": {
            "description": "Username of the user who performed the export.",
            "title": "Exported By",
            "type": "string"
        },
        "exportVersion": {
            "description": "Version tag of the exporting system.",
            "title": "Export Version",
            "type": "string"
        },
        "checksum": {
            "description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
            "title": "Export Checksum",
            "type": "string"
        },
        "definition": {
            "$ref": "#/components/schemas/CohortCreate",
            "description": "The cohort definition",
            "title": "Cohort Definition"
        }
    },
    "required": [
        "exportedAt",
        "exportedBy",
        "exportVersion",
        "checksum",
        "definition"
    ],
    "title": "ExportedCohortDefinition",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/history/events

Get All Cohort History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/history/events/{eventId}

Get Cohort History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/cohorts/{cohortId}/history/events/{eventId}/reversion

Revert Cohort To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
eventId path string No

Response 201 Created

{
    "id": "429fa0b1-b9f1-4f1a-855c-25292d497e21",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/cohorts/{cohortId}/dataset/{datasetId}/export

Export Cohort Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
datasetId path string No

Response 200 OK

{
    "exportedAt": "2022-04-13T15:42:05.901Z",
    "exportedBy": "string",
    "exportVersion": "string",
    "checksum": "string",
    "dataset": [
        {
            "anonymized": true,
            "id": "bab2372d-1c80-4d0b-9e0a-56e92d37275e",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "clinicalCenter": "string",
            "clinicalIdentifier": "string",
            "consentStatus": null,
            "gender": null,
            "race": null,
            "sexAtBirth": null,
            "genderIdentity": null,
            "dateOfBirth": null,
            "vitalStatus": null,
            "dateOfDeath": "2022-04-13",
            "causeOfDeath": null,
            "endOfRecords": "2022-04-13",
            "pseudoidentifier": "string",
            "age": null,
            "overallSurvival": 10.12,
            "ageAtDiagnosis": null,
            "dataCompletionRate": 10.12,
            "contributors": [
                "string"
            ],
            "neoplasticEntities": [
                {
                    "anonymized": true,
                    "id": "f0c94bd9-92e8-4c20-8caf-953dd516f598",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "88f2ef13-9c1d-4e03-9d94-3c8f815ca03a",
                    "relationship": null,
                    "relatedPrimaryId": "5bfc077f-cc8c-470e-a329-b4558d95c7b9",
                    "assertionDate": "2022-04-13",
                    "topography": null,
                    "morphology": null,
                    "differentitation": null,
                    "laterality": null,
                    "topographyGroup": null
                }
            ],
            "tnmStagings": [
                {
                    "anonymized": true,
                    "id": "f9c7631a-e0ac-407a-acf1-81a9b042493d",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "374dcc8f-dcf6-42b7-8a23-9d9174e8cf39",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "b1beab51-5c9b-4c77-87e0-50f88851947b"
                    ],
                    "stage": null,
                    "methodology": null,
                    "pathological": true,
                    "primarytumor": null,
                    "regionalnodes": null,
                    "distantmetastases": null,
                    "grade": null,
                    "residualtumor": null,
                    "lymphaticinvasion": null,
                    "venousinvasion": null,
                    "perineuralinvasion": null,
                    "serumtumormarkerlevel": null
                }
            ],
            "figoStagings": null,
            "binetStagings": [
                {
                    "anonymized": true,
                    "id": "00d33405-6b39-4fc8-8b48-4b7559257ec9",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "6e2978d5-32f1-4ca4-a773-543281d48d88",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "b2aea545-3b43-4091-9f89-964a4814f390"
                    ],
                    "stage": null
                }
            ],
            "raiStagings": [
                {
                    "anonymized": true,
                    "id": "3b628992-5b29-450b-91b3-c72619984dd5",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "80cad6f0-e758-4a68-99f9-3dc89ebafe16",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "893626fa-c2f5-47cd-87a5-f102627c03c6"
                    ],
                    "stage": null,
                    "methodology": null
                }
            ],
            "breslowStagings": [
                {
                    "anonymized": true,
                    "id": "75f6114a-deac-4cfb-ae55-81a65b284d1c",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "2c424cf6-d7d7-4983-85ee-964a5476a46f",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "4b185128-908c-4a92-ba5d-e050ac227390"
                    ],
                    "depth": null,
                    "isUlcered": true,
                    "stage": null
                }
            ],
            "clarkStagings": [
                {
                    "anonymized": true,
                    "id": "42f94059-758f-46e0-bf05-8a41f9fab99c",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "2a7925e0-23c3-48dd-b15c-5252e9d76927",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "8752ba03-6104-4126-9ccf-bfff729dc7b8"
                    ],
                    "stage": null
                }
            ],
            "issStagings": [
                {
                    "anonymized": true,
                    "id": "35191451-2655-4ac5-9ebc-0aa82ac306ba",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "1fe23694-6a6f-41f6-abab-5e611eaa8e3f",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "772a62b5-b59f-40fe-95b4-25e01d5c09fe"
                    ],
                    "stage": null
                }
            ],
            "rissStagings": [
                {
                    "anonymized": true,
                    "id": "33a16eee-307e-4b88-8f2a-930076621b8a",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "16bd6cd5-acd6-4d69-aa09-25c29e68d22c",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "a257a3e3-5815-48e7-bc67-9d01a575ada1"
                    ],
                    "stage": null
                }
            ],
            "inssStagings": [
                {
                    "anonymized": true,
                    "id": "3764d0d3-f2b4-4b91-8425-3679ff50cef1",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "7e24fbc1-bb09-46f8-9503-b6da3aeef68d",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "fb7697b9-6b72-4dab-a954-ef74ba424080"
                    ],
                    "stage": null
                }
            ],
            "inrgssStagings": [
                {
                    "anonymized": true,
                    "id": "eb07e858-648d-41ee-8887-6e246e8d0c78",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f37fcb01-0d8a-4fc6-ba8b-d6b06943150e",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "404d1334-7b5d-423c-82ef-615219ed4094"
                    ],
                    "stage": null
                }
            ],
            "gleasonStagings": [
                {
                    "anonymized": true,
                    "id": "71f75b90-cefb-42a6-bc54-8cf323101367",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f1e0993f-acb3-4d4f-b8fa-746ab0da51a0",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "82cb0e98-9b80-4b0d-821a-bad22241b941"
                    ],
                    "stage": null
                }
            ],
            "rhabdomyosarcomaGroups": [
                {
                    "anonymized": true,
                    "id": "2e2a419b-21f4-4ef4-b169-de6364b390bc",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f47335ad-661f-4f4e-a975-6a1936ca05ae",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "0e4c571d-cb69-409b-8b37-9a0a3d816aa6"
                    ],
                    "stage": null
                }
            ],
            "wilmsStagings": [
                {
                    "anonymized": true,
                    "id": "d6a5a33d-c232-4ebc-b7cd-3b1638f69978",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "7169901c-a1a6-41e0-873b-26399e2f06ea",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "a3cb658b-0a7f-4d8a-8624-504c3f01da96"
                    ],
                    "stage": null
                }
            ],
            "lymphomaStagings": [
                {
                    "anonymized": true,
                    "id": "72ccea9e-bdbb-468f-96cc-a80c21083822",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "3b749e88-daae-41f3-9c77-c4df66e0ea91",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "9e784dd3-2188-4396-bfd3-65bd94116faf"
                    ],
                    "stage": null,
                    "methodology": null,
                    "bulky": true,
                    "pathological": true,
                    "modifiers": null
                }
            ],
            "tumorMarkers": [
                {
                    "anonymized": true,
                    "id": "4b130a4f-ed9c-414e-aa14-d5af898e812a",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "704d722e-869e-417c-8e2f-dd2f0f27f989",
                    "date": "2022-04-13",
                    "analyte": null,
                    "massConcentration": null,
                    "arbitraryConcentration": null,
                    "substanceConcentration": null,
                    "fraction": null,
                    "multipleOfMedian": null,
                    "tumorProportionScore": null,
                    "immuneCellScore": null,
                    "combinedPositiveScore": null,
                    "immunohistochemicalScore": null,
                    "presence": null,
                    "nuclearExpressionStatus": null,
                    "relatedEntitiesIds": [
                        "861cb54b-dce7-4910-8c5d-937600658fc1"
                    ]
                }
            ],
            "riskAssessments": [
                {
                    "anonymized": true,
                    "id": "f51d8f98-226a-47ae-9d8c-6ac4a4138164",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "546bd93f-eb4d-4e5d-a4eb-0c7cd804837e",
                    "date": "2022-04-13",
                    "methodology": null,
                    "risk": null,
                    "score": 10.12,
                    "assessedEntitiesIds": [
                        "5dd62b53-7182-44f1-a93d-9b310a545e01"
                    ]
                }
            ],
            "therapyLines": [
                {
                    "anonymized": true,
                    "id": "df294d1a-d70d-40eb-8af2-dafda70e5e8c",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "41371581-e70b-4427-b0f5-3d8fea069a45",
                    "ordinal": 0,
                    "intent": null,
                    "progressionDate": "2022-04-13",
                    "period": "string",
                    "label": "string",
                    "progressionFreeSurvival": 10.12
                }
            ],
            "systemicTherapies": [
                {
                    "anonymized": true,
                    "id": "5489b3e3-456b-48e1-ab35-626b06401caf",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "b56a12d5-a815-47d2-a7eb-cb627095ff63",
                    "period": "string",
                    "cycles": 0,
                    "intent": null,
                    "adjunctiveRole": null,
                    "terminationReason": null,
                    "therapyLineId": "89b5f55c-fb90-4ff0-b24b-7640791e4e6a",
                    "targetedEntitiesIds": [
                        "d6b8616b-e3b3-4ed3-958e-592230efddf6"
                    ],
                    "medications": [
                        {
                            "anonymized": true,
                            "id": "b493f077-dd77-43c0-a782-c645b80b83ca",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "drug": null,
                            "route": null,
                            "usedOfflabel": true,
                            "withinSoc": true,
                            "dosageMassConcentration": null,
                            "dosageMass": null,
                            "dosageVolume": null,
                            "dosageMassSurface": null,
                            "dosageRateMassConcentration": null,
                            "dosageRateMass": null,
                            "dosageRateVolume": null,
                            "dosageRateMassSurface": null
                        }
                    ],
                    "isAdjunctive": true,
                    "duration": null
                }
            ],
            "surgeries": [
                {
                    "anonymized": true,
                    "id": "56620062-98de-4cd6-a570-5f6332074851",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "d5d6c8d8-ad36-42e2-b9d3-23068e78b1ad",
                    "date": "2022-04-13",
                    "procedure": null,
                    "intent": null,
                    "bodysite": null,
                    "bodysiteQualifier": null,
                    "bodysiteLaterality": null,
                    "outcome": null,
                    "therapyLineId": "a6ab38fb-b29b-4d40-b810-777a02907488",
                    "targetedEntitiesIds": [
                        "b48739c1-51f7-4cb7-9ada-6bc5935a3c8d"
                    ]
                }
            ],
            "radiotherapies": [
                {
                    "anonymized": true,
                    "id": "a9a7e1c2-935a-4af4-b0e9-ae923960e10d",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f8a182d8-4c5b-4b5c-8256-8e8ba27739a4",
                    "period": "string",
                    "sessions": 0,
                    "intent": null,
                    "terminationReason": null,
                    "therapyLineId": "4f6ff12f-f75d-4908-bc93-81c2df37a52f",
                    "targetedEntitiesIds": [
                        "606c7303-002a-4dee-837e-20276e455442"
                    ],
                    "duration": null,
                    "dosages": [
                        {
                            "anonymized": true,
                            "id": "8118716b-ba56-446c-b513-e9c3313124eb",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "fractions": 0,
                            "dose": null,
                            "irradiatedVolume": null,
                            "irradiatedVolumeMorphology": null,
                            "irradiatedVolumeQualifier": null
                        }
                    ],
                    "settings": [
                        {
                            "anonymized": true,
                            "id": "837a0c1b-08e1-4b57-a104-5719980d1db6",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "modality": null,
                            "technique": null
                        }
                    ]
                }
            ],
            "adverseEvents": [
                {
                    "anonymized": true,
                    "id": "3cf87f21-edbf-4cf0-a810-08830947a102",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f06f2a45-9245-44a5-8634-519143d67aed",
                    "date": "2022-04-13",
                    "event": null,
                    "grade": 0,
                    "outcome": null,
                    "dateResolved": "2022-04-13",
                    "suspectedCauses": [
                        {
                            "anonymized": true,
                            "id": "303650c9-ce01-42c4-acc6-cc55929dfaab",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "systemicTherapyId": "c21593ef-18ac-436d-8190-9763d8b6a0d0",
                            "medicationId": "bb8a078e-8fd9-41f8-9d64-79584570e2d3",
                            "radiotherapyId": "a5338fc2-6874-47eb-ab18-a4b96e94f881",
                            "surgeryId": "9dccc013-0a76-4a5c-a339-c08cabe1a38a",
                            "causality": null
                        }
                    ],
                    "mitigations": [
                        {
                            "anonymized": true,
                            "id": "71078c5a-8ab1-4d21-ba83-33884b250c55",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "category": null,
                            "adjustment": null,
                            "drug": null,
                            "procedure": null,
                            "management": null
                        }
                    ]
                }
            ],
            "treatmentResponses": [
                {
                    "anonymized": true,
                    "id": "b82d1a5b-e3b1-4fa6-a173-57e3a5838864",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "e3f92326-1729-4588-8ecc-0e500c5354a1",
                    "date": "2022-04-13",
                    "recist": null,
                    "recistInterpreted": true,
                    "methodology": null,
                    "assessedEntitiesIds": [
                        "ff1c2061-1934-4939-98d9-e3dcb942e534"
                    ],
                    "assessedBodysites": null
                }
            ],
            "performanceStatus": [
                {
                    "anonymized": true,
                    "id": "78f44304-9905-4d4d-8036-2344d11a6299",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "60179f4d-9a02-49a1-88af-79d686eb9f7a",
                    "date": "2022-04-13",
                    "ecogScore": 0,
                    "karnofskyScore": 0,
                    "ecogInterpretation": null,
                    "karnofskyInterpretation": null
                }
            ],
            "comorbidities": [
                {
                    "anonymized": true,
                    "id": "b1f7b4c7-bb25-4e60-ae4d-8077f9036b58",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "ceba30a7-e76f-43b8-a842-f0ffa26e823d",
                    "date": "2022-04-13",
                    "indexConditionId": "b5080e79-bc13-41db-b66d-7dff9f13357c",
                    "panel": null,
                    "presentConditions": null,
                    "absentConditions": null,
                    "score": null
                }
            ],
            "genomicVariants": [
                {
                    "anonymized": true,
                    "id": "f28a3270-0b9e-40eb-bd49-4b75131679e5",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f2bb3cfd-3aa3-4501-8d1c-bf09fcf561f1",
                    "date": "2022-04-13",
                    "genes": null,
                    "dnaHgvs": "string",
                    "rnaHgvs": "string",
                    "proteinHgvs": "string",
                    "assessmentDate": "2022-04-13",
                    "genePanel": "string",
                    "assessment": null,
                    "confidence": null,
                    "analysisMethod": null,
                    "clinicalRelevance": null,
                    "genomeAssemblyVersion": null,
                    "molecularConsequence": null,
                    "copyNumber": 0,
                    "alleleFrequency": 10.12,
                    "alleleDepth": 0,
                    "zygosity": null,
                    "inheritance": null,
                    "coordinateSystem": null,
                    "clinvar": "string",
                    "isPathogenic": true,
                    "isVUS": true,
                    "dnaReferenceSequence": "string",
                    "dnaChangePosition": 0,
                    "dnaChangePositionRange": null,
                    "dnaChangeType": null,
                    "rnaReferenceSequence": "string",
                    "rnaChangePosition": "string",
                    "rnaChangeType": null,
                    "proteinReferenceSequence": "string",
                    "proteinChangeType": null,
                    "nucleotidesLength": 0,
                    "regions": [
                        "string"
                    ]
                }
            ],
            "tumorMutationalBurdens": [
                {
                    "anonymized": true,
                    "id": "ad12bffc-3c93-46bf-aa99-f392132d28d4",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "ca8df1dc-d90f-42b2-be35-3e05077642f3",
                    "date": "2022-04-13",
                    "value": 10.12,
                    "status": null
                }
            ],
            "microsatelliteInstabilities": [
                {
                    "anonymized": true,
                    "id": "1d04464e-2a0d-42ef-8c83-4c36f2996080",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "0f03dee7-2208-476f-9045-4d8a166b3f85",
                    "date": "2022-04-13",
                    "value": null
                }
            ],
            "lossesOfHeterozygosity": [
                {
                    "anonymized": true,
                    "id": "b209f98b-21d4-47db-88fe-72f9c2963802",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "fc2e43fb-7e96-4f31-8476-bc088d8078e3",
                    "date": "2022-04-13",
                    "value": 10.12
                }
            ],
            "homologousRecombinationDeficiencies": [
                {
                    "anonymized": true,
                    "id": "a0d811e0-4f57-43b1-81c1-731c0f95b145",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "c8f689d9-a92a-44dc-8e3b-39e405d4c895",
                    "date": "2022-04-13",
                    "value": 10.12,
                    "interpretation": null
                }
            ],
            "tumorNeoantigenBurdens": [
                {
                    "anonymized": true,
                    "id": "b9e00b47-b259-48ba-81ed-b687d682fa96",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "1836b8a2-bfb1-4135-8117-e1502ea64cad",
                    "date": "2022-04-13",
                    "value": 10.12
                }
            ],
            "aneuploidScores": [
                {
                    "anonymized": true,
                    "id": "c3b17b07-2692-4c39-9b2a-5931f8515a5b",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f846605c-a967-4462-a8e2-c1ff3bb93ea0",
                    "date": "2022-04-13",
                    "value": 0
                }
            ],
            "vitals": [
                {
                    "anonymized": true,
                    "id": "35e459e1-d3cd-4106-a34e-c3c72315a70d",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "7aa874f7-ceb7-45c3-9a97-ad5afa193026",
                    "date": "2022-04-13",
                    "height": null,
                    "weight": null,
                    "bloodPressureSystolic": null,
                    "bloodPressureDiastolic": null,
                    "temperature": null,
                    "bodyMassIndex": null
                }
            ],
            "lifestyles": [
                {
                    "anonymized": true,
                    "id": "a65bf9f0-0b9b-44a9-bcc6-2f7de5aa7d1c",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "e33aaad3-2827-45e4-b07b-ec3ef52ed085",
                    "date": "2022-04-13",
                    "smokingStatus": null,
                    "smokingPackyears": 10.12,
                    "smokingQuited": null,
                    "alcoholConsumption": null,
                    "nightSleep": null,
                    "recreationalDrugs": null,
                    "exposures": null
                }
            ],
            "familyHistory": [
                {
                    "anonymized": true,
                    "id": "42d8be0a-5695-4e6b-acfe-c8925af82fd8",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "4f4a5e61-3ca4-4f1e-8413-2364f0b627ba",
                    "date": "2022-04-13",
                    "relationship": null,
                    "hadCancer": true,
                    "contributedToDeath": true,
                    "onsetAge": 0,
                    "topography": null,
                    "morphology": null
                }
            ],
            "unspecifiedTumorBoards": [
                {
                    "anonymized": true,
                    "id": "a7312218-3cba-4978-a091-703b326ba787",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "e0d608f4-d0d8-4bf2-af93-f6c4e4c0f131",
                    "date": "2022-04-13",
                    "relatedEntitiesIds": [
                        "86c245ce-b8a3-4024-a0ed-8b95bf1723c4"
                    ],
                    "recommendations": null
                }
            ],
            "molecularTumorBoards": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "exportedAt": {
            "description": "The datetime when the resource was exported.",
            "format": "date-time",
            "title": "Export Timestamp",
            "type": "string"
        },
        "exportedBy": {
            "description": "Username of the user who performed the export.",
            "title": "Exported By",
            "type": "string"
        },
        "exportVersion": {
            "description": "Version tag of the exporting system.",
            "title": "Export Version",
            "type": "string"
        },
        "checksum": {
            "description": "Checksum (e.g., SHA256) of the exported content for integrity verification.",
            "title": "Export Checksum",
            "type": "string"
        },
        "dataset": {
            "description": "The dataset that was exported",
            "items": {
                "$ref": "#/components/schemas/PatientCaseDataset"
            },
            "title": "Dataset",
            "type": "array"
        }
    },
    "required": [
        "exportedAt",
        "exportedBy",
        "exportVersion",
        "checksum",
        "dataset"
    ],
    "title": "ExportedPatientCaseDataset",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/cohorts/{cohortId}/dataset

Construct Cohort Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
limit query integer 10 No
offset query integer 0 No

Request body

[
    {
        "resource": "PatientCase",
        "field": "string",
        "transform": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "items": {
        "$ref": "#/components/schemas/DatasetRule"
    },
    "title": "Rules",
    "type": "array"
}

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "anonymized": true,
            "id": "b1280e82-7d88-443b-9520-68790de986ba",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "clinicalCenter": "string",
            "clinicalIdentifier": "string",
            "consentStatus": null,
            "gender": null,
            "race": null,
            "sexAtBirth": null,
            "genderIdentity": null,
            "dateOfBirth": null,
            "vitalStatus": null,
            "dateOfDeath": "2022-04-13",
            "causeOfDeath": null,
            "endOfRecords": "2022-04-13",
            "pseudoidentifier": "string",
            "age": null,
            "overallSurvival": 10.12,
            "ageAtDiagnosis": null,
            "dataCompletionRate": 10.12,
            "contributors": [
                "string"
            ],
            "neoplasticEntities": [
                {
                    "anonymized": true,
                    "id": "32edc87b-b3fa-4d56-a2b0-d08d5186bb83",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "17c1ca42-06a1-481b-b1aa-a3235df25ee2",
                    "relationship": null,
                    "relatedPrimaryId": "42968e2e-ca04-4f2d-9fce-6046e21cb574",
                    "assertionDate": "2022-04-13",
                    "topography": null,
                    "morphology": null,
                    "differentitation": null,
                    "laterality": null,
                    "topographyGroup": null
                }
            ],
            "tnmStagings": [
                {
                    "anonymized": true,
                    "id": "4ce2f3c2-aa7b-47c4-aa3b-2552d3f71fb1",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "7b3fb741-421c-4216-9836-69d2ee09f8cf",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "5696d5a9-1a13-40e2-a71f-816b425b3342"
                    ],
                    "stage": null,
                    "methodology": null,
                    "pathological": true,
                    "primarytumor": null,
                    "regionalnodes": null,
                    "distantmetastases": null,
                    "grade": null,
                    "residualtumor": null,
                    "lymphaticinvasion": null,
                    "venousinvasion": null,
                    "perineuralinvasion": null,
                    "serumtumormarkerlevel": null
                }
            ],
            "figoStagings": null,
            "binetStagings": [
                {
                    "anonymized": true,
                    "id": "876980f2-ef0b-4e6f-93b9-357fc350fb4c",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "d2066956-2fd5-42f2-8fb3-e6990372b223",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "b8e18476-a4a7-465f-9660-145f24be40d3"
                    ],
                    "stage": null
                }
            ],
            "raiStagings": [
                {
                    "anonymized": true,
                    "id": "c0a2f357-8a9a-4125-98c8-b597991bb3d5",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "ac7abf41-78ce-4ef8-a495-9877b8dac777",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "06a1ec58-7746-4dc6-a4e8-3f45f1df4e51"
                    ],
                    "stage": null,
                    "methodology": null
                }
            ],
            "breslowStagings": [
                {
                    "anonymized": true,
                    "id": "3cbce370-bc6e-4786-ad6e-ce9b8c76fa84",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "151333e9-269e-41e8-bb73-7a68ca2eeae7",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "ed4d1bf2-b82d-4c1f-bf0b-344b670bf35c"
                    ],
                    "depth": null,
                    "isUlcered": true,
                    "stage": null
                }
            ],
            "clarkStagings": [
                {
                    "anonymized": true,
                    "id": "0828f849-e45b-409b-a23d-8419460a84a7",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "8e268ef2-b8f9-4926-ae60-9a6f1c7abf8f",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "6951fa25-1651-4f73-b385-93161aa3a44d"
                    ],
                    "stage": null
                }
            ],
            "issStagings": [
                {
                    "anonymized": true,
                    "id": "2e573d47-cfbe-4367-91c6-4e501e7e8f3a",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "d7ca4af8-a090-4197-be38-c8dbd0b31454",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "a1d77f9f-3b2e-4e9e-8e64-187a1e5c1fcf"
                    ],
                    "stage": null
                }
            ],
            "rissStagings": [
                {
                    "anonymized": true,
                    "id": "47a7b9ca-f39b-483d-86c0-a0e86da12878",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "95fe8ad6-712a-4a50-8dad-a915cd88a727",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "2edd6eb4-a933-4112-b4bc-b73883688018"
                    ],
                    "stage": null
                }
            ],
            "inssStagings": [
                {
                    "anonymized": true,
                    "id": "d4145f14-0f7f-4d30-8331-9ccd1af72d72",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "7cd800c2-a8e2-48e5-a623-b9d287afbea9",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "c6a207c4-8f4a-4790-a80f-506a4dc762a3"
                    ],
                    "stage": null
                }
            ],
            "inrgssStagings": [
                {
                    "anonymized": true,
                    "id": "7a7530cb-8dea-4170-8424-c20087ae76ab",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "548a1f24-9e74-4cd9-a8f5-8bf1c928cd01",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "e4ee9892-c976-457b-aab1-02495e1ba794"
                    ],
                    "stage": null
                }
            ],
            "gleasonStagings": [
                {
                    "anonymized": true,
                    "id": "b4867281-ac28-410b-a713-584fcb5852ab",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "38894ab1-4045-46a3-83e2-80b41c061a70",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "7b67eaa1-dce3-4cae-b651-c452ad66a20d"
                    ],
                    "stage": null
                }
            ],
            "rhabdomyosarcomaGroups": [
                {
                    "anonymized": true,
                    "id": "b45ce47e-f777-492a-95e8-09a55d6f0e96",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "ab35a1a8-dedb-44af-a127-8fa9cf05aab6",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "0393baf1-e3ce-4a8f-80de-04233262f2e3"
                    ],
                    "stage": null
                }
            ],
            "wilmsStagings": [
                {
                    "anonymized": true,
                    "id": "123e589c-071b-4c55-9093-2eb02922639a",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "59c026dd-51d4-4769-b5c3-0e29c18d7dbe",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "c522f366-de29-4958-a893-51e8e1aa3c4f"
                    ],
                    "stage": null
                }
            ],
            "lymphomaStagings": [
                {
                    "anonymized": true,
                    "id": "9e38b32d-d804-430f-880e-cd6a0ff384cd",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "stagingDomain": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "88d81374-0561-4d3a-abb5-25a44e3d32e0",
                    "date": "2022-04-13",
                    "stagedEntitiesIds": [
                        "8c6c6edf-5ba0-4767-bd49-9193a5f69817"
                    ],
                    "stage": null,
                    "methodology": null,
                    "bulky": true,
                    "pathological": true,
                    "modifiers": null
                }
            ],
            "tumorMarkers": [
                {
                    "anonymized": true,
                    "id": "aeb6c1d8-c604-432e-81b4-9de7016ab0f1",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "1cd68f08-1814-4394-bb7f-d06cb02ec640",
                    "date": "2022-04-13",
                    "analyte": null,
                    "massConcentration": null,
                    "arbitraryConcentration": null,
                    "substanceConcentration": null,
                    "fraction": null,
                    "multipleOfMedian": null,
                    "tumorProportionScore": null,
                    "immuneCellScore": null,
                    "combinedPositiveScore": null,
                    "immunohistochemicalScore": null,
                    "presence": null,
                    "nuclearExpressionStatus": null,
                    "relatedEntitiesIds": [
                        "4e119985-3bc9-48c1-bc3b-9cd3918f2a24"
                    ]
                }
            ],
            "riskAssessments": [
                {
                    "anonymized": true,
                    "id": "c4edee1b-80d9-4ca9-9805-c5104345dba4",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "26405ada-3e79-415d-879e-453d0912dd3e",
                    "date": "2022-04-13",
                    "methodology": null,
                    "risk": null,
                    "score": 10.12,
                    "assessedEntitiesIds": [
                        "ad68d728-1660-4012-8fd7-087a7a526c5f"
                    ]
                }
            ],
            "therapyLines": [
                {
                    "anonymized": true,
                    "id": "cae53db0-4886-4f25-8a8f-6acdf864dd48",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "54d04491-68e2-4691-938c-5481210d01f0",
                    "ordinal": 0,
                    "intent": null,
                    "progressionDate": "2022-04-13",
                    "period": "string",
                    "label": "string",
                    "progressionFreeSurvival": 10.12
                }
            ],
            "systemicTherapies": [
                {
                    "anonymized": true,
                    "id": "7de029f6-e53e-4529-8d76-abb81611a5ee",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "3d3f3479-ae59-493f-917f-b550d222fb0f",
                    "period": "string",
                    "cycles": 0,
                    "intent": null,
                    "adjunctiveRole": null,
                    "terminationReason": null,
                    "therapyLineId": "592d96cb-7316-4300-b7a8-cf6b0e3a2de8",
                    "targetedEntitiesIds": [
                        "30dd2b62-20e8-4640-9a60-3e89992fc396"
                    ],
                    "medications": [
                        {
                            "anonymized": true,
                            "id": "e5edadaa-bc44-4bbe-b0fc-82a083848cb9",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "drug": null,
                            "route": null,
                            "usedOfflabel": true,
                            "withinSoc": true,
                            "dosageMassConcentration": null,
                            "dosageMass": null,
                            "dosageVolume": null,
                            "dosageMassSurface": null,
                            "dosageRateMassConcentration": null,
                            "dosageRateMass": null,
                            "dosageRateVolume": null,
                            "dosageRateMassSurface": null
                        }
                    ],
                    "isAdjunctive": true,
                    "duration": null
                }
            ],
            "surgeries": [
                {
                    "anonymized": true,
                    "id": "17f2b7eb-46d4-4720-9f2a-9c492a363f40",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "4c7df81f-b359-4411-9f24-5410b5d723af",
                    "date": "2022-04-13",
                    "procedure": null,
                    "intent": null,
                    "bodysite": null,
                    "bodysiteQualifier": null,
                    "bodysiteLaterality": null,
                    "outcome": null,
                    "therapyLineId": "82a4c606-3be6-4ffb-8fb2-f155d3cfa6b2",
                    "targetedEntitiesIds": [
                        "f7dfc0d6-a75c-4494-b1bd-21f5a8b7de23"
                    ]
                }
            ],
            "radiotherapies": [
                {
                    "anonymized": true,
                    "id": "9b702b6a-7d4a-4f63-950a-ba27585f2041",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "888d466f-fabf-4d4e-88bf-14ba0309e626",
                    "period": "string",
                    "sessions": 0,
                    "intent": null,
                    "terminationReason": null,
                    "therapyLineId": "6bd87f9a-24d4-4382-8b8d-62b66719a6fb",
                    "targetedEntitiesIds": [
                        "02115fa5-c9f2-4b90-bee1-ab7a788dd196"
                    ],
                    "duration": null,
                    "dosages": [
                        {
                            "anonymized": true,
                            "id": "f94475cd-f6f0-4bf1-8bc0-e50617b876f7",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "fractions": 0,
                            "dose": null,
                            "irradiatedVolume": null,
                            "irradiatedVolumeMorphology": null,
                            "irradiatedVolumeQualifier": null
                        }
                    ],
                    "settings": [
                        {
                            "anonymized": true,
                            "id": "21253f38-a0c7-4fd0-aa52-038b90dc4559",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "modality": null,
                            "technique": null
                        }
                    ]
                }
            ],
            "adverseEvents": [
                {
                    "anonymized": true,
                    "id": "22481c28-5706-4379-8581-59c97de49870",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "bfe35893-9555-45ea-9a67-b22eb555549b",
                    "date": "2022-04-13",
                    "event": null,
                    "grade": 0,
                    "outcome": null,
                    "dateResolved": "2022-04-13",
                    "suspectedCauses": [
                        {
                            "anonymized": true,
                            "id": "e91149ae-6be3-47f6-bbb3-11829463176b",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "systemicTherapyId": "d7b9f1be-78f4-4b85-85a5-220f3f8d0c11",
                            "medicationId": "459e8d00-1dd8-44f3-8cba-784c080ea383",
                            "radiotherapyId": "ef662d87-656c-4f6e-b5cd-0bb61853b773",
                            "surgeryId": "1950a896-e66c-41c0-96a3-ce284cbad057",
                            "causality": null
                        }
                    ],
                    "mitigations": [
                        {
                            "anonymized": true,
                            "id": "67543a84-d3cf-4076-bec9-415fcac3c9ea",
                            "createdAt": "2022-04-13T15:42:05.901Z",
                            "updatedAt": "2022-04-13T15:42:05.901Z",
                            "createdBy": "string",
                            "updatedBy": [
                                "string"
                            ],
                            "externalSource": "string",
                            "externalSourceId": "string",
                            "category": null,
                            "adjustment": null,
                            "drug": null,
                            "procedure": null,
                            "management": null
                        }
                    ]
                }
            ],
            "treatmentResponses": [
                {
                    "anonymized": true,
                    "id": "8ee66047-193a-4aec-97c5-4f0e60993680",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "1e377581-183a-434d-bfa5-df6f5f80344d",
                    "date": "2022-04-13",
                    "recist": null,
                    "recistInterpreted": true,
                    "methodology": null,
                    "assessedEntitiesIds": [
                        "12b1f9d3-470d-4d7b-afab-f33f7f6b42e9"
                    ],
                    "assessedBodysites": null
                }
            ],
            "performanceStatus": [
                {
                    "anonymized": true,
                    "id": "2518d7ae-a490-4f18-b6d9-ec467f78d176",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "9681d2cd-6ab8-412e-abfa-0927bfb53d51",
                    "date": "2022-04-13",
                    "ecogScore": 0,
                    "karnofskyScore": 0,
                    "ecogInterpretation": null,
                    "karnofskyInterpretation": null
                }
            ],
            "comorbidities": [
                {
                    "anonymized": true,
                    "id": "f038a9fc-d2a8-40f0-93e3-e4e8b466c052",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "b8d641c2-398e-4023-9bbf-0014a9e75c79",
                    "date": "2022-04-13",
                    "indexConditionId": "541e190f-66bd-41d1-b700-4e33d0fab87e",
                    "panel": null,
                    "presentConditions": null,
                    "absentConditions": null,
                    "score": null
                }
            ],
            "genomicVariants": [
                {
                    "anonymized": true,
                    "id": "fae872fc-639c-40cb-8df0-00a72e66d4d5",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "3bbc3f03-ff51-4b58-8160-b94cbd161f72",
                    "date": "2022-04-13",
                    "genes": null,
                    "dnaHgvs": "string",
                    "rnaHgvs": "string",
                    "proteinHgvs": "string",
                    "assessmentDate": "2022-04-13",
                    "genePanel": "string",
                    "assessment": null,
                    "confidence": null,
                    "analysisMethod": null,
                    "clinicalRelevance": null,
                    "genomeAssemblyVersion": null,
                    "molecularConsequence": null,
                    "copyNumber": 0,
                    "alleleFrequency": 10.12,
                    "alleleDepth": 0,
                    "zygosity": null,
                    "inheritance": null,
                    "coordinateSystem": null,
                    "clinvar": "string",
                    "isPathogenic": true,
                    "isVUS": true,
                    "dnaReferenceSequence": "string",
                    "dnaChangePosition": 0,
                    "dnaChangePositionRange": null,
                    "dnaChangeType": null,
                    "rnaReferenceSequence": "string",
                    "rnaChangePosition": "string",
                    "rnaChangeType": null,
                    "proteinReferenceSequence": "string",
                    "proteinChangeType": null,
                    "nucleotidesLength": 0,
                    "regions": [
                        "string"
                    ]
                }
            ],
            "tumorMutationalBurdens": [
                {
                    "anonymized": true,
                    "id": "dcdfb42d-8e82-4f86-a674-5f9ec1012d39",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "d7d0da66-dd07-4b9b-82d5-72a789a9e990",
                    "date": "2022-04-13",
                    "value": 10.12,
                    "status": null
                }
            ],
            "microsatelliteInstabilities": [
                {
                    "anonymized": true,
                    "id": "c791f8bf-8517-4c9f-b778-62d6c65b255d",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "583ae4ad-e994-478b-867c-fb66a5f1e522",
                    "date": "2022-04-13",
                    "value": null
                }
            ],
            "lossesOfHeterozygosity": [
                {
                    "anonymized": true,
                    "id": "39282a5d-8081-46f7-bec6-26868fef2aa7",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "d0329731-8d11-4e48-9e95-501b7b8f59c2",
                    "date": "2022-04-13",
                    "value": 10.12
                }
            ],
            "homologousRecombinationDeficiencies": [
                {
                    "anonymized": true,
                    "id": "67e30653-7b01-493e-9109-8f531a43a442",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "77c3c8f4-032f-4578-be38-98ede3b9e40a",
                    "date": "2022-04-13",
                    "value": 10.12,
                    "interpretation": null
                }
            ],
            "tumorNeoantigenBurdens": [
                {
                    "anonymized": true,
                    "id": "b5e211d1-a84d-4991-ad9d-cd22dcac69ec",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "8116cd00-3b8d-439e-9596-9ec2d8735584",
                    "date": "2022-04-13",
                    "value": 10.12
                }
            ],
            "aneuploidScores": [
                {
                    "anonymized": true,
                    "id": "25657e52-4761-4df6-baad-cf6dcad05838",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "18370007-c79e-434e-aaaf-5a252172cece",
                    "date": "2022-04-13",
                    "value": 0
                }
            ],
            "vitals": [
                {
                    "anonymized": true,
                    "id": "3deb1314-1d2a-4877-af08-b07335951625",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "dd00e41c-77db-46cb-87cc-3c3371a44296",
                    "date": "2022-04-13",
                    "height": null,
                    "weight": null,
                    "bloodPressureSystolic": null,
                    "bloodPressureDiastolic": null,
                    "temperature": null,
                    "bodyMassIndex": null
                }
            ],
            "lifestyles": [
                {
                    "anonymized": true,
                    "id": "0f0c7a81-947d-4a54-a6e6-9971ca9a41e7",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "45f647c7-7d77-4c21-b868-f15b745b3101",
                    "date": "2022-04-13",
                    "smokingStatus": null,
                    "smokingPackyears": 10.12,
                    "smokingQuited": null,
                    "alcoholConsumption": null,
                    "nightSleep": null,
                    "recreationalDrugs": null,
                    "exposures": null
                }
            ],
            "familyHistory": [
                {
                    "anonymized": true,
                    "id": "c32c22b5-54c4-4b0f-ac26-81fe8368c9c7",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "506718cb-c63e-4d97-93a5-a4ea2f8014b6",
                    "date": "2022-04-13",
                    "relationship": null,
                    "hadCancer": true,
                    "contributedToDeath": true,
                    "onsetAge": 0,
                    "topography": null,
                    "morphology": null
                }
            ],
            "unspecifiedTumorBoards": [
                {
                    "anonymized": true,
                    "id": "c05bdeaf-8e4d-493c-981d-188d5cb1345f",
                    "createdAt": "2022-04-13T15:42:05.901Z",
                    "updatedAt": "2022-04-13T15:42:05.901Z",
                    "createdBy": "string",
                    "updatedBy": [
                        "string"
                    ],
                    "category": "string",
                    "externalSource": "string",
                    "externalSourceId": "string",
                    "caseId": "f61b4ddb-dbb1-4b68-978c-593c7145da01",
                    "date": "2022-04-13",
                    "relatedEntitiesIds": [
                        "11555515-88aa-4e70-b44d-5a93bebba859"
                    ],
                    "recommendations": null
                }
            ],
            "molecularTumorBoards": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/PatientCaseDataset"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[PatientCaseDataset]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/traits

Get Cohort Traits Statistics

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Response 200 OK

{
    "age": {
        "median": null,
        "interQuartalRange": null
    },
    "dataCompletion": null,
    "overallSurvival": null,
    "genders": [
        {
            "category": "string",
            "counts": 0,
            "percentage": 10.12
        }
    ],
    "neoplasticSites": null,
    "therapyLines": null,
    "consentStatus": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing key traits and distributions within a patient cohort.\n\nAttributes:\n    age (CohortTraitMedian): Median age of individuals in the cohort.\n    dataCompletion (CohortTraitMedian): Median percentage of completed data per patient.\n    overallSurvival (Nullable[CohortTraitMedian]): Median overall survival time in the cohort, if available.\n    genders (List[CohortTraitCounts]): Distribution of genders within the cohort.\n    neoplasticSites (List[CohortTraitCounts]): Distribution of neoplastic (tumor) sites in the cohort.\n    therapyLines (List[CohortTraitCounts]): Distribution of therapy lines received by patients in the cohort.\n    consentStatus (List[CohortTraitCounts]): Distribution of consent statuses for data use among cohort participants.",
    "properties": {
        "age": {
            "$ref": "#/components/schemas/CohortTraitMedian",
            "description": "Median age of individuals in the cohort.",
            "title": "Age"
        },
        "dataCompletion": {
            "$ref": "#/components/schemas/CohortTraitMedian",
            "description": "Median percentage of completed data per patient.",
            "title": "Data Completion"
        },
        "overallSurvival": {
            "$ref": "#/components/schemas/CohortTraitMedian",
            "description": "Median overall survival time in the cohort, if available.",
            "title": "Overall Survival"
        },
        "genders": {
            "description": "Distribution of genders within the cohort.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Genders",
            "type": "array"
        },
        "neoplasticSites": {
            "description": "Distribution of neoplastic (tumor) sites in the cohort.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Neoplastic Sites",
            "type": "array"
        },
        "therapyLines": {
            "description": "Distribution of therapy lines received by patients in the cohort.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Therapy Lines",
            "type": "array"
        },
        "consentStatus": {
            "description": "Distribution of consent statuses for data use among cohort participants.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Consent Status",
            "type": "array"
        }
    },
    "required": [
        "age",
        "dataCompletion",
        "overallSurvival",
        "genders",
        "neoplasticSites",
        "therapyLines",
        "consentStatus"
    ],
    "title": "CohortTraits",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Data Analysis


GET /api/v1/cohorts/{cohortId}/analysis/distribution

Get Cohort Property Distribution

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
property query string No

Response 200 OK

{
    "metadata": null,
    "items": [
        {
            "category": "string",
            "counts": 0,
            "percentage": 10.12
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a statistical distribution of trait counts within a cohort.\n\nAttributes:\n    items (List[CohortTraitCounts]): The entries in the distribution, each representing\n        a category and its associated counts and percentage.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "items": {
            "description": "The entries in the distribution.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "items"
    ],
    "title": "Distribution",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/analysis/overall-survical/kaplan-meier

Get Cohort Overall Survival Curve

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
confidence query number 0.95 No

Response 200 OK

{
    "metadata": null,
    "months": [
        10.12
    ],
    "probabilities": [
        10.12
    ],
    "lowerConfidenceBand": [
        10.12
    ],
    "upperConfidenceBand": [
        10.12
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a Kaplan-Meier survival curve, including survival probabilities and confidence intervals.\n\nAttributes:\n    months (List[float]): List of time points (in months) for survival probability estimates.\n    probabilities (List[float]): Survival probabilities at each time point.\n    lowerConfidenceBand (List[float]): Lower bound of the survival probability confidence interval at each time point.\n    upperConfidenceBand (List[float]): Upper bound of the survival probability confidence interval at each time point.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "months": {
            "description": "List of time points (in months) for survival probability estimates.",
            "items": {
                "type": "number"
            },
            "title": "Months",
            "type": "array"
        },
        "probabilities": {
            "description": "Survival probabilities at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Probabilities",
            "type": "array"
        },
        "lowerConfidenceBand": {
            "description": "Lower bound of the survival probability confidence interval at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Lower Confidence Band",
            "type": "array"
        },
        "upperConfidenceBand": {
            "description": "Upper bound of the survival probability confidence interval at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Upper Confidence Band",
            "type": "array"
        }
    },
    "required": [
        "months",
        "probabilities",
        "lowerConfidenceBand",
        "upperConfidenceBand"
    ],
    "title": "KaplanMeierCurve",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/analysis/oncoplot

Get Cohort Oncoplot Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No

Response 200 OK

{
    "metadata": null,
    "genes": [
        "string"
    ],
    "cases": [
        "string"
    ],
    "variants": [
        {
            "gene": "string",
            "caseId": "string",
            "hgvsExpression": "string",
            "isPathogenic": true
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing the dataset required for generating an Oncoplot visualization.\n\nAttributes:\n    genes (List[str]): List of the most frequently encountered gene names.\n    cases (List[str]): List of patient case identifiers.\n    variants (List[OncoplotVariant]): List of variant records included in the Oncoplot.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "genes": {
            "description": "List of most frequently encountered genes",
            "items": {
                "type": "string"
            },
            "title": "Genes",
            "type": "array"
        },
        "cases": {
            "description": "List of patient cases",
            "items": {
                "type": "string"
            },
            "title": "Cases",
            "type": "array"
        },
        "variants": {
            "description": "Variants included in the Oncoplot",
            "items": {
                "$ref": "#/components/schemas/OncoplotVariant"
            },
            "title": "Variants",
            "type": "array"
        }
    },
    "required": [
        "genes",
        "cases",
        "variants"
    ],
    "title": "OncoplotDataset",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survival/kaplan-meier

Get Cohort Line Progression Free Survival Curve

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
confidence query number 0.95 No
therapyLine path string No

Response 200 OK

{
    "metadata": null,
    "months": [
        10.12
    ],
    "probabilities": [
        10.12
    ],
    "lowerConfidenceBand": [
        10.12
    ],
    "upperConfidenceBand": [
        10.12
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing a Kaplan-Meier survival curve, including survival probabilities and confidence intervals.\n\nAttributes:\n    months (List[float]): List of time points (in months) for survival probability estimates.\n    probabilities (List[float]): Survival probabilities at each time point.\n    lowerConfidenceBand (List[float]): Lower bound of the survival probability confidence interval at each time point.\n    upperConfidenceBand (List[float]): Upper bound of the survival probability confidence interval at each time point.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "months": {
            "description": "List of time points (in months) for survival probability estimates.",
            "items": {
                "type": "number"
            },
            "title": "Months",
            "type": "array"
        },
        "probabilities": {
            "description": "Survival probabilities at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Probabilities",
            "type": "array"
        },
        "lowerConfidenceBand": {
            "description": "Lower bound of the survival probability confidence interval at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Lower Confidence Band",
            "type": "array"
        },
        "upperConfidenceBand": {
            "description": "Upper bound of the survival probability confidence interval at each time point.",
            "items": {
                "type": "number"
            },
            "title": "Upper Confidence Band",
            "type": "array"
        }
    },
    "required": [
        "months",
        "probabilities",
        "lowerConfidenceBand",
        "upperConfidenceBand"
    ],
    "title": "KaplanMeierCurve",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/progression-free-survivals/categories

Get Cohort Line Progression Free Survival By Categories

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
categorization query None No
cohortId path string No
therapyLine path string No

Response 200 OK

{
    "metadata": null,
    "survivals": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema for categorizing progression free survival (PFS) data within a cohort based on therapy-related groupings.\n\nAttributes:\n    survivals (Dict[str, List[float]]): A dictionary mapping category names (e.g., drug combinations or therapy classifications) to lists of progression free survival values.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "survivals": {
            "additionalProperties": {
                "items": {
                    "type": "number"
                },
                "type": "array"
            },
            "title": "Survivals",
            "type": "object"
        }
    },
    "required": [
        "survivals"
    ],
    "title": "CategorizedSurvivals",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/cohorts/{cohortId}/analysis/{therapyLine}/distribution

Get Cohort Line Property Distribution

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortId path string No
property query string No
therapyLine path string No

Response 200 OK

{
    "metadata": null,
    "items": [
        {
            "category": "string",
            "counts": 0,
            "percentage": 10.12
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a statistical distribution of trait counts within a cohort.\n\nAttributes:\n    items (List[CohortTraitCounts]): The entries in the distribution, each representing\n        a category and its associated counts and percentage.",
    "properties": {
        "metadata": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalysisMetadata"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Metadata for the Kaplan-Meier curve.",
            "title": "Metadata"
        },
        "items": {
            "description": "The entries in the distribution.",
            "items": {
                "$ref": "#/components/schemas/CohortTraitCounts"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "items"
    ],
    "title": "Distribution",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Dashboard


GET /api/v1/dashboard/stats

Get Full Cohort Statistics

Description

Retrieves comprehensive statistics for the full cohort, including counts of cases, primary sites, entries, mutations, clinical centers, contributors, cohorts, and projects.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Response 200 OK

{
    "cases": 0,
    "primarySites": 0,
    "projects": 0,
    "cohorts": 0,
    "entries": 0,
    "mutations": 0,
    "clinicalCenters": 0,
    "contributors": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing key statistics of the data platform.\n\nAttributes:\n    cases (int): Total number of unique patient cases in the data platform.\n    primarySites (int): Number of distinct primary anatomical sites represented.\n    projects (int): Total number of research projects.\n    cohorts (int): Number of defined cohorts in the platform.\n    entries (int): Total number of individual data entries recorded.\n    mutations (int): Total number of genetic mutations documented across all cases.\n    clinicalCenters (int): Number of clinical centers contributing data.\n    contributors (int): Total number of individual data contributors.",
    "properties": {
        "cases": {
            "description": "Total number of unique patient cases in the data platform.",
            "title": "Patient Cases",
            "type": "integer"
        },
        "primarySites": {
            "description": "Number of distinct primary anatomical sites represented.",
            "title": "Primary Sites",
            "type": "integer"
        },
        "projects": {
            "description": "Total number of research projects.",
            "title": "Projects",
            "type": "integer"
        },
        "cohorts": {
            "description": "Number of defined cohorts in the platform.",
            "title": "Cohorts",
            "type": "integer"
        },
        "entries": {
            "description": "Total number of individual data entries recorded.",
            "title": "Data Entries",
            "type": "integer"
        },
        "mutations": {
            "description": "Total number of genetic mutations documented across all cases.",
            "title": "Mutations",
            "type": "integer"
        },
        "clinicalCenters": {
            "description": "Number of clinical centers contributing data.",
            "title": "Clinical Centers",
            "type": "integer"
        },
        "contributors": {
            "description": "Total number of individual data contributors.",
            "title": "Contributors",
            "type": "integer"
        }
    },
    "required": [
        "cases",
        "primarySites",
        "projects",
        "cohorts",
        "entries",
        "mutations",
        "clinicalCenters",
        "contributors"
    ],
    "title": "DataPlatformStatistics",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/dashboard/primary-site-stats

Get Primary Site Statistics

Description

Retrieves statistical data for primary neoplastic entities grouped by topography.

This method performs the following steps:

  1. Selects distinct topography groups from primary neoplastic entities.
  2. For each topography group, identifies the cohort of patient cases associated with primary neoplastic entities matching the group's code.
  3. Calculates the population size and the median data completion rate for each cohort.
  4. Constructs a list of EntityStatistics objects containing the computed statistics and topography information.
  5. Sorts the statistics by population size in descending order.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Response 200 OK

[
    {
        "population": 0,
        "dataCompletionMedian": 10.12,
        "topographyCode": "string",
        "topographyGroup": "string"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/EntityStatistics"
    },
    "title": "Response",
    "type": "array"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/dashboard/cases-over-time

Get Cases Over Time

Description

Retrieves the cumulative count of patient cases over time, grouped by month.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Response 200 OK

[
    {
        "month": "2022-04-13",
        "cumulativeCount": 0
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "items": {
        "$ref": "#/components/schemas/CountsPerMonth"
    },
    "title": "Response",
    "type": "array"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/dashboard/data-completion-stats

Get Data Completion Statistics

Description

Computes and returns statistics on data completion for patient cases.

  • If there are no patient cases, returns zeroed statistics.
  • Uses Django ORM aggregation and annotation for efficient computation.
  • Identifies most incomplete categories and the most affected sites for each.
  • Tracks completion progress over time using monthly aggregation.

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Response 200 OK

{
    "totalCases": 0,
    "overallCompletion": 10.12,
    "mostIncompleteCategories": [
        {
            "category": "string",
            "cases": 0,
            "affectedSites": [
                {
                    "code": "string",
                    "system": "string",
                    "display": "string",
                    "version": "string",
                    "synonyms": [
                        "string"
                    ],
                    "properties": {}
                }
            ]
        }
    ],
    "completionOverTime": [
        {
            "month": "2022-04-13",
            "cumulativeCount": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Schema representing statistics on data completion for patient cases.\n\nAttributes:\n    totalCases (int): Total number of patient cases analyzed for data completeness.\n    overallCompletion (float): Overall percentage of data categories completed across all cases.\n    mostIncompleteCategories (List[IncompleteCategory]): List of the most common categories with missing data.\n    completionOverTime (List[CountsPerMonth]): Historical trend of cumulative data completeness by month.",
    "properties": {
        "totalCases": {
            "description": "Total number of patient cases analyzed for data completeness.",
            "title": "Total Cases",
            "type": "integer"
        },
        "overallCompletion": {
            "description": "Overall percentage of data categories completed across all cases.",
            "title": "Overall Completion (%)",
            "type": "number"
        },
        "mostIncompleteCategories": {
            "description": "List of the most common categories with missing data.",
            "items": {
                "$ref": "#/components/schemas/IncompleteCategory"
            },
            "title": "Most Incomplete Categories",
            "type": "array"
        },
        "completionOverTime": {
            "description": "Historical trend of cumulative data completeness by month.",
            "items": {
                "$ref": "#/components/schemas/CountsPerMonth"
            },
            "title": "Completion Over Time",
            "type": "array"
        }
    },
    "required": [
        "totalCases",
        "overallCompletion",
        "mostIncompleteCategories",
        "completionOverTime"
    ],
    "title": "DataCompletionStatistics",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error

Datasets


GET /api/v1/datasets

Get All Datasets Matching The Query

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
cohortsIds query string No Cohorts - Filter for full text matches
cohortsIds.anyOf query array No Cohorts - Filter for entries where at least one reference matches the query
cohortsIds.beginsWith query string No Cohorts - Filter for entries starting with the text
cohortsIds.contains query string No Cohorts - Filter for partial text matches
cohortsIds.endsWith query string No Cohorts - Filter for entries ending with the text
cohortsIds.not query string No Cohorts - Filter for full text mismatches
cohortsIds.not.anyOf query array No Cohorts - Filter for entries where at least one reference mismatches the query
cohortsIds.not.beginsWith query string No Cohorts - Filter for entries not starting with the text
cohortsIds.not.contains query string No Cohorts - Filter for partial text mismatches
cohortsIds.not.endsWith query string No Cohorts - Filter for entries not ending with the text
createdAt.after query string No Created at - Filter for entries with dates after the specified value
createdAt.before query string No Created at - Filter for entries with dates before the specified value
createdAt.between query array No Created at - Filter for entries with dates between two specified values (inclusive)
createdAt.exists query boolean No Created at - Filter for entries with a value
createdAt.not.between query array No Created at - Filter for entries with dates not between two specified values (inclusive)
createdAt.not.exists query boolean No Created at - Filter for entries without a value
createdAt.not.on query string No Created at - Filter for entries with dates not matching the specified value
createdAt.on query string No Created at - Filter for entries with dates exactly matching the specified value
createdAt.onOrAfter query string No Created at - Filter for entries with dates on or after the specified value
createdAt.onOrBefore query string No Created at - Filter for entries with dates on or before the specified value
createdBy query string No Filter datasets by the creator's username.
externalSource query string No External data source - Filter for full text matches
externalSource.anyOf query array No External data source - Filter for entries where at least one reference matches the query
externalSource.beginsWith query string No External data source - Filter for entries starting with the text
externalSource.contains query string No External data source - Filter for partial text matches
externalSource.endsWith query string No External data source - Filter for entries ending with the text
externalSource.exists query boolean No External data source - Filter for entries with a value
externalSource.not query string No External data source - Filter for full text mismatches
externalSource.not.anyOf query array No External data source - Filter for entries where at least one reference mismatches the query
externalSource.not.beginsWith query string No External data source - Filter for entries not starting with the text
externalSource.not.contains query string No External data source - Filter for partial text mismatches
externalSource.not.endsWith query string No External data source - Filter for entries not ending with the text
externalSource.not.exists query boolean No External data source - Filter for entries without a value
id query string No Id - Filter for full text matches
id.anyOf query array No Id - Filter for entries where at least one reference matches the query
id.beginsWith query string No Id - Filter for entries starting with the text
id.contains query string No Id - Filter for partial text matches
id.endsWith query string No Id - Filter for entries ending with the text
id.not query string No Id - Filter for full text mismatches
id.not.anyOf query array No Id - Filter for entries where at least one reference mismatches the query
id.not.beginsWith query string No Id - Filter for entries not starting with the text
id.not.contains query string No Id - Filter for partial text mismatches
id.not.endsWith query string No Id - Filter for entries not ending with the text
lastExport.after query string No Last Export - Filter for entries with dates after the specified value
lastExport.before query string No Last Export - Filter for entries with dates before the specified value
lastExport.between query array No Last Export - Filter for entries with dates between two specified values (inclusive)
lastExport.exists query boolean No Last Export - Filter for entries with a value
lastExport.not.between query array No Last Export - Filter for entries with dates not between two specified values (inclusive)
lastExport.not.exists query boolean No Last Export - Filter for entries without a value
lastExport.not.on query string No Last Export - Filter for entries with dates not matching the specified value
lastExport.on query string No Last Export - Filter for entries with dates exactly matching the specified value
lastExport.onOrAfter query string No Last Export - Filter for entries with dates on or after the specified value
lastExport.onOrBefore query string No Last Export - Filter for entries with dates on or before the specified value
limit query integer 10 No
name query string No Dataset name - Filter for full text matches
name.anyOf query array No Dataset name - Filter for entries where at least one reference matches the query
name.beginsWith query string No Dataset name - Filter for entries starting with the text
name.contains query string No Dataset name - Filter for partial text matches
name.endsWith query string No Dataset name - Filter for entries ending with the text
name.not query string No Dataset name - Filter for full text mismatches
name.not.anyOf query array No Dataset name - Filter for entries where at least one reference mismatches the query
name.not.beginsWith query string No Dataset name - Filter for entries not starting with the text
name.not.contains query string No Dataset name - Filter for partial text mismatches
name.not.endsWith query string No Dataset name - Filter for entries not ending with the text
offset query integer 0 No
ordering query None No
projectId query string No Project - Filter for reference matches
projectId.anyOf query array No Project - Filter for entries where at least one reference matches the query
projectId.beginsWith query string No Project - Filter for entries starting with the text
projectId.contains query string No Project - Filter for partial text matches
projectId.endsWith query string No Project - Filter for entries ending with the text
projectId.not query string No Project - Filter for reference mismatches
projectId.not.anyOf query array No Project - Filter for entries where at least one reference mismatches the query
projectId.not.beginsWith query string No Project - Filter for entries not starting with the text
projectId.not.contains query string No Project - Filter for partial text mismatches
projectId.not.endsWith query string No Project - Filter for entries not ending with the text
rules.field query string No Field - Filter for full text matches
rules.field.anyOf query array No Field - Filter for entries where at least one reference matches the query
rules.field.beginsWith query string No Field - Filter for entries starting with the text
rules.field.contains query string No Field - Filter for partial text matches
rules.field.endsWith query string No Field - Filter for entries ending with the text
rules.field.not query string No Field - Filter for full text mismatches
rules.field.not.anyOf query array No Field - Filter for entries where at least one reference mismatches the query
rules.field.not.beginsWith query string No Field - Filter for entries not starting with the text
rules.field.not.contains query string No Field - Filter for partial text mismatches
rules.field.not.endsWith query string No Field - Filter for entries not ending with the text
rules.resource query None No Resource - Filter for single value choice
rules.resource.anyOf query array No Resource - ('Filter for excluding a subset of value choices',)
rules.resource.not query None No Resource - ('Filter for all but a single value choice',)
rules.transform query string No Transform - Filter for full text matches
rules.transform.anyOf query array No Transform - Filter for entries where at least one reference matches the query
rules.transform.beginsWith query string No Transform - Filter for entries starting with the text
rules.transform.contains query string No Transform - Filter for partial text matches
rules.transform.endsWith query string No Transform - Filter for entries ending with the text
rules.transform.exists query boolean No Transform - Filter for entries with a value
rules.transform.not query string No Transform - Filter for full text mismatches
rules.transform.not.anyOf query array No Transform - Filter for entries where at least one reference mismatches the query
rules.transform.not.beginsWith query string No Transform - Filter for entries not starting with the text
rules.transform.not.contains query string No Transform - Filter for partial text mismatches
rules.transform.not.endsWith query string No Transform - Filter for entries not ending with the text
rules.transform.not.exists query boolean No Transform - Filter for entries without a value
summary query string No Dataset summary - Filter for full text matches
summary.anyOf query array No Dataset summary - Filter for entries where at least one reference matches the query
summary.beginsWith query string No Dataset summary - Filter for entries starting with the text
summary.contains query string No Dataset summary - Filter for partial text matches
summary.endsWith query string No Dataset summary - Filter for entries ending with the text
summary.exists query boolean No Dataset summary - Filter for entries with a value
summary.not query string No Dataset summary - Filter for full text mismatches
summary.not.anyOf query array No Dataset summary - Filter for entries where at least one reference mismatches the query
summary.not.beginsWith query string No Dataset summary - Filter for entries not starting with the text
summary.not.contains query string No Dataset summary - Filter for partial text mismatches
summary.not.endsWith query string No Dataset summary - Filter for entries not ending with the text
summary.not.exists query boolean No Dataset summary - Filter for entries without a value
totalExports.between query array No Total Exports - Filter for entries with values between two specified values (inclusive)
totalExports.equal query integer No Total Exports - Filter for entries with values exactly equal to the specified value
totalExports.greaterThan query integer No Total Exports - Filter for entries with values greater than the specified value
totalExports.greaterThanOrEqual query integer No Total Exports - Filter for entries with values greater than or equal to the specified value
totalExports.lessThan query integer No Total Exports - Filter for entries with values less than the specified value
totalExports.lessThanOrEqual query integer No Total Exports - Filter for entries with values less than or equal to the specified value
totalExports.not.between query array No Total Exports - Filter for entries with values between two specified values (inclusive)
totalExports.not.equal query integer No Total Exports - Filter for entries with values not equal to the specified value
updatedAt.after query string No Updated at - Filter for entries with dates after the specified value
updatedAt.before query string No Updated at - Filter for entries with dates before the specified value
updatedAt.between query array No Updated at - Filter for entries with dates between two specified values (inclusive)
updatedAt.exists query boolean No Updated at - Filter for entries with a value
updatedAt.not.between query array No Updated at - Filter for entries with dates not between two specified values (inclusive)
updatedAt.not.exists query boolean No Updated at - Filter for entries without a value
updatedAt.not.on query string No Updated at - Filter for entries with dates not matching the specified value
updatedAt.on query string No Updated at - Filter for entries with dates exactly matching the specified value
updatedAt.onOrAfter query string No Updated at - Filter for entries with dates on or after the specified value
updatedAt.onOrBefore query string No Updated at - Filter for entries with dates on or before the specified value

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": "e008891c-4838-4778-b2b5-0459d050c947",
            "description": "string",
            "createdAt": "2022-04-13T15:42:05.901Z",
            "updatedAt": "2022-04-13T15:42:05.901Z",
            "createdBy": "string",
            "updatedBy": [
                "string"
            ],
            "rules": [
                {
                    "resource": "PatientCase",
                    "field": "string",
                    "transform": null
                }
            ],
            "externalSource": "string",
            "externalSourceId": "string",
            "name": "string",
            "summary": "string",
            "projectId": "ae49f039-7aa0-4aae-ab49-f265b0945917",
            "lastExport": "2022-04-13T15:42:05.901Z",
            "totalExports": 0,
            "cohortsIds": [
                "string"
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/Dataset"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[Dataset]",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


POST /api/v1/datasets

Create Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key

Request body

{
    "rules": [
        {
            "resource": "PatientCase",
            "field": "string",
            "transform": null
        }
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "summary": "string",
    "projectId": "3bdd0812-4f94-4aea-b4e0-abbf36d77b2e"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "rules": {
            "default": [],
            "description": "List of composition rules that define the dataset's structure.",
            "items": {
                "$ref": "#/components/schemas/DatasetRule"
            },
            "title": "Rules",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the dataset",
            "maxLength": 255,
            "title": "Dataset name",
            "type": "string"
        },
        "summary": {
            "description": "Summary of the dataset",
            "title": "Dataset summary",
            "type": "string"
        },
        "projectId": {
            "description": "Project that the dataset is part of",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        }
    },
    "required": [
        "name",
        "projectId"
    ],
    "title": "DatasetCreate",
    "type": "object"
}

Response 201 Created

{
    "id": "cca719a7-ff1b-4b8d-a63b-90cf4ee22aa1",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/datasets/{datasetId}

Get Dataset By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No

Response 200 OK

{
    "id": "596399bd-6100-435f-b1a0-8e2d75d95e75",
    "description": "string",
    "createdAt": "2022-04-13T15:42:05.901Z",
    "updatedAt": "2022-04-13T15:42:05.901Z",
    "createdBy": "string",
    "updatedBy": [
        "string"
    ],
    "rules": [
        {
            "resource": "PatientCase",
            "field": "string",
            "transform": null
        }
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "summary": "string",
    "projectId": "5e5a87de-9302-410e-a19d-a2a723670d24",
    "lastExport": "2022-04-13T15:42:05.901Z",
    "totalExports": 0,
    "cohortsIds": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "id": {
            "description": "Unique identifier of the resource (UUID v4).",
            "format": "uuid",
            "title": "Id",
            "type": "string"
        },
        "description": {
            "description": "Human-readable description",
            "title": "Description",
            "type": "string"
        },
        "createdAt": {
            "description": "Date-time when the resource was created",
            "format": "date-time",
            "title": "Created at",
            "type": "string"
        },
        "updatedAt": {
            "description": "Date-time when the resource was last updated",
            "format": "date-time",
            "title": "Updated at",
            "type": "string"
        },
        "createdBy": {
            "description": "Username of the user who created the resource",
            "title": "Created by",
            "type": "string"
        },
        "updatedBy": {
            "description": "Usernames of the users who have updated the resource",
            "items": {
                "type": "string"
            },
            "title": "Updated by",
            "type": "array"
        },
        "rules": {
            "default": [],
            "description": "List of composition rules that define the dataset's structure.",
            "items": {
                "$ref": "#/components/schemas/DatasetRule"
            },
            "title": "Rules",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the dataset",
            "maxLength": 255,
            "title": "Dataset name",
            "type": "string"
        },
        "summary": {
            "description": "Summary of the dataset",
            "title": "Dataset summary",
            "type": "string"
        },
        "projectId": {
            "description": "Project that the dataset is part of",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        },
        "lastExport": {
            "description": "The datetime of the last export of this dataset",
            "format": "date-time",
            "title": "Last Export",
            "type": "string"
        },
        "totalExports": {
            "default": 0,
            "description": "The total number times this dataset has been exported",
            "title": "Total Exports",
            "type": "integer"
        },
        "cohortsIds": {
            "default": [],
            "description": "List of cohort IDs that have been exported with this dataset",
            "items": {
                "type": "string"
            },
            "title": "Cohorts",
            "type": "array"
        }
    },
    "required": [
        "id",
        "description",
        "name",
        "projectId"
    ],
    "title": "Dataset",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


DELETE /api/v1/datasets/{datasetId}

Delete Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No

Response 204 No Content

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/datasets/{datasetId}

Update Dataset

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No

Request body

{
    "rules": [
        {
            "resource": "PatientCase",
            "field": "string",
            "transform": null
        }
    ],
    "externalSource": "string",
    "externalSourceId": "string",
    "name": "string",
    "summary": "string",
    "projectId": "81a8b14c-2884-4674-bd82-14acf2eea0fe"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "properties": {
        "rules": {
            "default": [],
            "description": "List of composition rules that define the dataset's structure.",
            "items": {
                "$ref": "#/components/schemas/DatasetRule"
            },
            "title": "Rules",
            "type": "array"
        },
        "externalSource": {
            "description": "The digital source of the data, relevant for automated data",
            "title": "External data source",
            "type": "string"
        },
        "externalSourceId": {
            "description": "The data identifier at the digital source of the data, relevant for automated data",
            "title": "External data source Id",
            "type": "string"
        },
        "name": {
            "description": "Name of the dataset",
            "maxLength": 255,
            "title": "Dataset name",
            "type": "string"
        },
        "summary": {
            "description": "Summary of the dataset",
            "title": "Dataset summary",
            "type": "string"
        },
        "projectId": {
            "description": "Project that the dataset is part of",
            "format": "uuid",
            "title": "Project",
            "type": "string"
        }
    },
    "required": [
        "name",
        "projectId"
    ],
    "title": "DatasetCreate",
    "type": "object"
}

Response 200 OK

{
    "id": "eac298e0-4ce9-45e3-8497-b2f56813e919",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/datasets/{datasetId}/history/events

Get All Dataset History Events

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No
limit query integer 10 No
offset query integer 0 No
ordering query None No

Response 200 OK

{
    "count": 0,
    "items": [
        {
            "id": null,
            "resourceId": null,
            "category": "create",
            "timestamp": "2022-04-13T15:42:05.901Z",
            "user": "string",
            "url": "string",
            "resource": "string",
            "snapshot": {},
            "differential": {},
            "context": {}
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "title": "Count",
            "type": "integer"
        },
        "items": {
            "items": {
                "$ref": "#/components/schemas/HistoryEventWithSchema"
            },
            "title": "Items",
            "type": "array"
        }
    },
    "required": [
        "count",
        "items"
    ],
    "title": "Paginated[HistoryEvent.bind_schema.<locals>.HistoryEventWithSchema]",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


GET /api/v1/datasets/{datasetId}/history/events/{eventId}

Get Dataset History Event By Id

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No
eventId path string No

Response 200 OK

{
    "id": null,
    "resourceId": null,
    "category": "create",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "user": "string",
    "url": "string",
    "resource": "string",
    "snapshot": {},
    "differential": {},
    "context": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "HistoryEventWithSchema provides static methods to resolve snapshot and differential data from history event objects.",
    "properties": {
        "id": {
            "description": "The unique identifier of the history event",
            "title": "Event ID"
        },
        "resourceId": {
            "description": "The unique identifier of the tracked resource",
            "title": "Resource ID"
        },
        "category": {
            "$ref": "#/components/schemas/HistoryEventCategory",
            "description": "The type of history event",
            "title": "Category"
        },
        "timestamp": {
            "description": "Timestamp of the history event",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        },
        "user": {
            "description": "Username of the user that triggered the event, if applicable",
            "title": "User",
            "type": "string"
        },
        "url": {
            "description": "Endpoint URL through which the event was triggered, if applicable",
            "title": "Endpoint",
            "type": "string"
        },
        "resource": {
            "description": "Resource involved in the event, if applicable",
            "title": "Resource",
            "type": "string"
        },
        "snapshot": {
            "additionalProperties": true,
            "description": "Data snapshopt at the time of the event",
            "title": "Data snapshopt",
            "type": "object"
        },
        "differential": {
            "additionalProperties": true,
            "description": "Data changes introduced by the event, if applicable",
            "title": "Data differential",
            "type": "object"
        },
        "context": {
            "additionalProperties": true,
            "description": "Context sorrounding the event",
            "title": "Context",
            "type": "object"
        }
    },
    "required": [
        "id",
        "resourceId",
        "category",
        "timestamp",
        "snapshot",
        "differential",
        "context"
    ],
    "title": "HistoryEventWithSchema",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


PUT /api/v1/datasets/{datasetId}/history/events/{eventId}/reversion

Revert Dataset To History Event

Input parameters

Parameter In Type Default Nullable Description
XSessionTokenAuth header string N/A No API key
datasetId path string No
eventId path string No

Response 201 Created

{
    "id": "af1bb37a-e4e7-45ce-9bb4-778168b2d03a",
    "description": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Represents a resource that was modified in the system.\n\nAttributes:\n    id (UUID): Unique identifier (UUID4) of the modified resource.\n    description (Optional[str]): A human-readable description of the modified resource.",
    "properties": {
        "id": {
            "description": "Unique identifier (UUID4) of the modified resource.",
            "format": "uuid",
            "title": "ID",
            "type": "string"
        },
        "description": {
            "description": "A human-readable description of the modified resource.",
            "title": "Description",
            "type": "string"
        }
    },
    "required": [
        "id"
    ],
    "title": "ModifiedResource",
    "type": "object"
}

Response 404 Not Found

Response 401 Unauthorized

Response 403 Forbidden

Response 500 Internal Server Error


Schemas

AccessRoles

Type: string

AdverseEvent

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
dateResolved string(date)
description string
event CodedConcept
externalSource string
externalSourceId string
grade integer
id string(uuid)
mitigations Array<AdverseEventMitigation>
outcome AdverseEventOutcomeChoices
suspectedCauses Array<AdverseEventSuspectedCause>
updatedAt string(date-time)
updatedBy Array<string>

AdverseEventCreate

Name Type
caseId string(uuid)
date string(date)
dateResolved string(date)
event CodedConcept
externalSource string
externalSourceId string
grade integer
outcome AdverseEventOutcomeChoices

AdverseEventFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
dateResolved.after string(date)
dateResolved.before string(date)
dateResolved.between Array<>
dateResolved.exists boolean
dateResolved.not.between Array<>
dateResolved.not.exists boolean
dateResolved.not.on string(date)
dateResolved.on string(date)
dateResolved.onOrAfter string(date)
dateResolved.onOrBefore string(date)
event string
event.anyOf Array<string>
event.descendantsOf string
event.not string
event.not.anyOf Array<string>
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
grade.between Array<>
grade.equal integer
grade.greaterThan integer
grade.greaterThanOrEqual integer
grade.lessThan integer
grade.lessThanOrEqual integer
grade.not.between Array<>
grade.not.equal integer
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
mitigations.adjustment string
mitigations.adjustment.anyOf Array<string>
mitigations.adjustment.descendantsOf string
mitigations.adjustment.exists boolean
mitigations.adjustment.not string
mitigations.adjustment.not.anyOf Array<string>
mitigations.adjustment.not.exists boolean
mitigations.category
mitigations.category.anyOf Array<string>
mitigations.category.not
mitigations.createdAt.after string(date)
mitigations.createdAt.before string(date)
mitigations.createdAt.between Array<>
mitigations.createdAt.exists boolean
mitigations.createdAt.not.between Array<>
mitigations.createdAt.not.exists boolean
mitigations.createdAt.not.on string(date)
mitigations.createdAt.on string(date)
mitigations.createdAt.onOrAfter string(date)
mitigations.createdAt.onOrBefore string(date)
mitigations.drug string
mitigations.drug.anyOf Array<string>
mitigations.drug.descendantsOf string
mitigations.drug.exists boolean
mitigations.drug.not string
mitigations.drug.not.anyOf Array<string>
mitigations.drug.not.exists boolean
mitigations.externalSource string
mitigations.externalSource.anyOf Array<string>
mitigations.externalSource.beginsWith string
mitigations.externalSource.contains string
mitigations.externalSource.endsWith string
mitigations.externalSource.exists boolean
mitigations.externalSource.not string
mitigations.externalSource.not.anyOf Array<string>
mitigations.externalSource.not.beginsWith string
mitigations.externalSource.not.contains string
mitigations.externalSource.not.endsWith string
mitigations.externalSource.not.exists boolean
mitigations.id string
mitigations.id.anyOf Array<string>
mitigations.id.beginsWith string
mitigations.id.contains string
mitigations.id.endsWith string
mitigations.id.not string
mitigations.id.not.anyOf Array<string>
mitigations.id.not.beginsWith string
mitigations.id.not.contains string
mitigations.id.not.endsWith string
mitigations.management string
mitigations.management.anyOf Array<string>
mitigations.management.descendantsOf string
mitigations.management.exists boolean
mitigations.management.not string
mitigations.management.not.anyOf Array<string>
mitigations.management.not.exists boolean
mitigations.procedure string
mitigations.procedure.anyOf Array<string>
mitigations.procedure.descendantsOf string
mitigations.procedure.exists boolean
mitigations.procedure.not string
mitigations.procedure.not.anyOf Array<string>
mitigations.procedure.not.exists boolean
mitigations.updatedAt.after string(date)
mitigations.updatedAt.before string(date)
mitigations.updatedAt.between Array<>
mitigations.updatedAt.exists boolean
mitigations.updatedAt.not.between Array<>
mitigations.updatedAt.not.exists boolean
mitigations.updatedAt.not.on string(date)
mitigations.updatedAt.on string(date)
mitigations.updatedAt.onOrAfter string(date)
mitigations.updatedAt.onOrBefore string(date)
outcome
outcome.anyOf Array<string>
outcome.not
suspectedCauses.causality
suspectedCauses.causality.anyOf Array<string>
suspectedCauses.causality.exists boolean
suspectedCauses.causality.not
suspectedCauses.causality.not.exists boolean
suspectedCauses.createdAt.after string(date)
suspectedCauses.createdAt.before string(date)
suspectedCauses.createdAt.between Array<>
suspectedCauses.createdAt.exists boolean
suspectedCauses.createdAt.not.between Array<>
suspectedCauses.createdAt.not.exists boolean
suspectedCauses.createdAt.not.on string(date)
suspectedCauses.createdAt.on string(date)
suspectedCauses.createdAt.onOrAfter string(date)
suspectedCauses.createdAt.onOrBefore string(date)
suspectedCauses.externalSource string
suspectedCauses.externalSource.anyOf Array<string>
suspectedCauses.externalSource.beginsWith string
suspectedCauses.externalSource.contains string
suspectedCauses.externalSource.endsWith string
suspectedCauses.externalSource.exists boolean
suspectedCauses.externalSource.not string
suspectedCauses.externalSource.not.anyOf Array<string>
suspectedCauses.externalSource.not.beginsWith string
suspectedCauses.externalSource.not.contains string
suspectedCauses.externalSource.not.endsWith string
suspectedCauses.externalSource.not.exists boolean
suspectedCauses.id string
suspectedCauses.id.anyOf Array<string>
suspectedCauses.id.beginsWith string
suspectedCauses.id.contains string
suspectedCauses.id.endsWith string
suspectedCauses.id.not string
suspectedCauses.id.not.anyOf Array<string>
suspectedCauses.id.not.beginsWith string
suspectedCauses.id.not.contains string
suspectedCauses.id.not.endsWith string
suspectedCauses.medicationId string
suspectedCauses.medicationId.anyOf Array<string>
suspectedCauses.medicationId.beginsWith string
suspectedCauses.medicationId.contains string
suspectedCauses.medicationId.endsWith string
suspectedCauses.medicationId.exists boolean
suspectedCauses.medicationId.not string
suspectedCauses.medicationId.not.anyOf Array<string>
suspectedCauses.medicationId.not.beginsWith string
suspectedCauses.medicationId.not.contains string
suspectedCauses.medicationId.not.endsWith string
suspectedCauses.medicationId.not.exists boolean
suspectedCauses.radiotherapyId string
suspectedCauses.radiotherapyId.anyOf Array<string>
suspectedCauses.radiotherapyId.beginsWith string
suspectedCauses.radiotherapyId.contains string
suspectedCauses.radiotherapyId.endsWith string
suspectedCauses.radiotherapyId.exists boolean
suspectedCauses.radiotherapyId.not string
suspectedCauses.radiotherapyId.not.anyOf Array<string>
suspectedCauses.radiotherapyId.not.beginsWith string
suspectedCauses.radiotherapyId.not.contains string
suspectedCauses.radiotherapyId.not.endsWith string
suspectedCauses.radiotherapyId.not.exists boolean
suspectedCauses.surgeryId string
suspectedCauses.surgeryId.anyOf Array<string>
suspectedCauses.surgeryId.beginsWith string
suspectedCauses.surgeryId.contains string
suspectedCauses.surgeryId.endsWith string
suspectedCauses.surgeryId.exists boolean
suspectedCauses.surgeryId.not string
suspectedCauses.surgeryId.not.anyOf Array<string>
suspectedCauses.surgeryId.not.beginsWith string
suspectedCauses.surgeryId.not.contains string
suspectedCauses.surgeryId.not.endsWith string
suspectedCauses.surgeryId.not.exists boolean
suspectedCauses.systemicTherapyId string
suspectedCauses.systemicTherapyId.anyOf Array<string>
suspectedCauses.systemicTherapyId.beginsWith string
suspectedCauses.systemicTherapyId.contains string
suspectedCauses.systemicTherapyId.endsWith string
suspectedCauses.systemicTherapyId.exists boolean
suspectedCauses.systemicTherapyId.not string
suspectedCauses.systemicTherapyId.not.anyOf Array<string>
suspectedCauses.systemicTherapyId.not.beginsWith string
suspectedCauses.systemicTherapyId.not.contains string
suspectedCauses.systemicTherapyId.not.endsWith string
suspectedCauses.systemicTherapyId.not.exists boolean
suspectedCauses.updatedAt.after string(date)
suspectedCauses.updatedAt.before string(date)
suspectedCauses.updatedAt.between Array<>
suspectedCauses.updatedAt.exists boolean
suspectedCauses.updatedAt.not.between Array<>
suspectedCauses.updatedAt.not.exists boolean
suspectedCauses.updatedAt.not.on string(date)
suspectedCauses.updatedAt.on string(date)
suspectedCauses.updatedAt.onOrAfter string(date)
suspectedCauses.updatedAt.onOrBefore string(date)
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

AdverseEventMitigation

Name Type
adjustment
category AdverseEventMitigationCategoryChoices
createdAt string(date-time)
createdBy string
description string
drug
externalSource string
externalSourceId string
id string(uuid)
management
procedure
updatedAt string(date-time)
updatedBy Array<string>

AdverseEventMitigationCategoryChoices

Type: string

AdverseEventMitigationCreate

Name Type
adjustment
category AdverseEventMitigationCategoryChoices
drug
externalSource string
externalSourceId string
management
procedure

AdverseEventMitigationPartial

Name Type
adjustment
anonymized boolean
category
createdAt string(date-time)
createdBy string
drug
externalSource string
externalSourceId string
id string(uuid)
management
procedure
updatedAt string(date-time)
updatedBy Array<string>

AdverseEventOutcomeChoices

Type: string

AdverseEventPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
dateResolved string(date)
event
externalSource string
externalSourceId string
grade integer
id string(uuid)
mitigations Array<AdverseEventMitigationPartial>
outcome
suspectedCauses Array<AdverseEventSuspectedCausePartial>
updatedAt string(date-time)
updatedBy Array<string>

AdverseEventSuspectedCause

Name Type
causality
createdAt string(date-time)
createdBy string
description string
externalSource string
externalSourceId string
id string(uuid)
medicationId string(uuid)
radiotherapyId string(uuid)
surgeryId string(uuid)
systemicTherapyId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

AdverseEventSuspectedCauseCausalityChoices

Type: string

AdverseEventSuspectedCauseCreate

Name Type
causality
externalSource string
externalSourceId string
medicationId string(uuid)
radiotherapyId string(uuid)
surgeryId string(uuid)
systemicTherapyId string(uuid)

AdverseEventSuspectedCausePartial

Name Type
anonymized boolean
causality
createdAt string(date-time)
createdBy string
externalSource string
externalSourceId string
id string(uuid)
medicationId string(uuid)
radiotherapyId string(uuid)
surgeryId string(uuid)
systemicTherapyId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

AgeBin

Type: string

AnalysisMetadata

Name Type
analyzedAt string(date-time)
cohortId string
cohortPopulation integer

AnalyteDetails

Name Type
acronym string
display string
valueTypes Array<AnalyteResultType>

AnalyteResultType

Type: string

AneuploidScore

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value integer

AneuploidScoreCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
value integer

AneuploidScorePartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value integer

AnyGenomicSignature

Type:

AnyStaging

Type:

AnyTumorBoard

Type:

AuthenticationMeta

Name Type
accessToken string
isAuthenticated boolean
sessionToken string

BinetStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

BinetStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

BinetStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

BreslowDepth

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
depth Measure
description string
externalSource string
externalSourceId string
id string(uuid)
isUlcered boolean
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

BreslowDepthCreate

Name Type
caseId string(uuid)
date string(date)
depth Measure
externalSource string
externalSourceId string
isUlcered boolean
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

BreslowDepthPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
depth
externalSource string
externalSourceId string
id string(uuid)
isUlcered boolean
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

CategorizedSurvivals

Name Type
metadata
survivals

ClarkStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

ClarkStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

ClarkStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

CodedConcept

Name Type
code string
display string
properties
synonyms Array<string>
system string
version string

Cohort

Name Type
casesIds Array<string(uuid)>
createdAt string(date-time)
createdBy string
description string
excludeCriteria
externalSource string
externalSourceId string
frozenSetIds Array<string(uuid)>
id string(uuid)
includeCriteria
manualChoicesIds Array<string(uuid)>
name string
population integer
projectId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

CohortContribution

Name Type
contributions integer
contributor string

CohortCreate

Name Type
casesIds Array<string(uuid)>
excludeCriteria
externalSource string
externalSourceId string
frozenSetIds Array<string(uuid)>
includeCriteria
manualChoicesIds Array<string(uuid)>
name string
projectId string(uuid)

CohortFilters

Name Type
casesIds string
casesIds.anyOf Array<string>
casesIds.beginsWith string
casesIds.contains string
casesIds.endsWith string
casesIds.exists boolean
casesIds.not string
casesIds.not.anyOf Array<string>
casesIds.not.beginsWith string
casesIds.not.contains string
casesIds.not.endsWith string
casesIds.not.exists boolean
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
createdBy string
excludeCriteria.exists boolean
excludeCriteria.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
frozenSetIds string
frozenSetIds.anyOf Array<string>
frozenSetIds.beginsWith string
frozenSetIds.contains string
frozenSetIds.endsWith string
frozenSetIds.exists boolean
frozenSetIds.not string
frozenSetIds.not.anyOf Array<string>
frozenSetIds.not.beginsWith string
frozenSetIds.not.contains string
frozenSetIds.not.endsWith string
frozenSetIds.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
includeCriteria.exists boolean
includeCriteria.not.exists boolean
manualChoicesIds string
manualChoicesIds.anyOf Array<string>
manualChoicesIds.beginsWith string
manualChoicesIds.contains string
manualChoicesIds.endsWith string
manualChoicesIds.exists boolean
manualChoicesIds.not string
manualChoicesIds.not.anyOf Array<string>
manualChoicesIds.not.beginsWith string
manualChoicesIds.not.contains string
manualChoicesIds.not.endsWith string
manualChoicesIds.not.exists boolean
name string
name.anyOf Array<string>
name.beginsWith string
name.contains string
name.endsWith string
name.not string
name.not.anyOf Array<string>
name.not.beginsWith string
name.not.contains string
name.not.endsWith string
population.between Array<>
population.equal integer
population.greaterThan integer
population.greaterThanOrEqual integer
population.lessThan integer
population.lessThanOrEqual integer
population.not.between Array<>
population.not.equal integer
projectId string
projectId.anyOf Array<string>
projectId.beginsWith string
projectId.contains string
projectId.endsWith string
projectId.exists boolean
projectId.not string
projectId.not.anyOf Array<string>
projectId.not.beginsWith string
projectId.not.contains string
projectId.not.endsWith string
projectId.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

CohortQueryEntity

Type: string

CohortQueryFilter

Type: string

CohortRule

Name Type
entity CohortQueryEntity
filters Array<CohortRuleFilter>

CohortRuleFilter

Name Type
field string
operator CohortQueryFilter
value

CohortRuleset

Name Type
condition
rules Array<>

CohortTraitCounts

Name Type
category string
counts integer
percentage number

CohortTraitMedian

Name Type
interQuartalRange
median

CohortTraits

Name Type
age CohortTraitMedian
consentStatus Array<CohortTraitCounts>
dataCompletion CohortTraitMedian
genders Array<CohortTraitCounts>
neoplasticSites Array<CohortTraitCounts>
overallSurvival CohortTraitMedian
therapyLines Array<CohortTraitCounts>

ComorbiditiesAssessment

Name Type
absentConditions Array<CodedConcept>
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
indexConditionId string(uuid)
panel
presentConditions Array<CodedConcept>
score
updatedAt string(date-time)
updatedBy Array<string>

ComorbiditiesAssessmentCreate

Name Type
absentConditions Array<CodedConcept>
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
indexConditionId string(uuid)
panel
presentConditions Array<CodedConcept>

ComorbiditiesAssessmentFilters

Name Type
absentConditions string
absentConditions.allOf Array<string>
absentConditions.anyOf Array<string>
absentConditions.descendantsOf string
absentConditions.exists boolean
absentConditions.not string
absentConditions.not.allOf Array<string>
absentConditions.not.anyOf Array<string>
absentConditions.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
indexConditionId string
indexConditionId.anyOf Array<string>
indexConditionId.beginsWith string
indexConditionId.contains string
indexConditionId.endsWith string
indexConditionId.not string
indexConditionId.not.anyOf Array<string>
indexConditionId.not.beginsWith string
indexConditionId.not.contains string
indexConditionId.not.endsWith string
panel
panel.anyOf Array<string>
panel.exists boolean
panel.not
panel.not.exists boolean
presentConditions string
presentConditions.allOf Array<string>
presentConditions.anyOf Array<string>
presentConditions.descendantsOf string
presentConditions.exists boolean
presentConditions.not string
presentConditions.not.allOf Array<string>
presentConditions.not.anyOf Array<string>
presentConditions.not.exists boolean
score.between Array<>
score.equal integer
score.exists boolean
score.greaterThan integer
score.greaterThanOrEqual integer
score.lessThan integer
score.lessThanOrEqual integer
score.not.between Array<>
score.not.equal integer
score.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

ComorbiditiesAssessmentPanelChoices

Type: string

ComorbiditiesAssessmentPartial

Name Type
absentConditions
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
indexConditionId string(uuid)
panel
presentConditions
score
updatedAt string(date-time)
updatedBy Array<string>

ComorbiditiesPanel

Name Type
categories Array<ComorbidityPanelCategory>
name string

ComorbidityPanelCategory

Name Type
conditions Array<CodedConcept>
default
label string

ConflictResolution

Type: string

CountsPerMonth

Name Type
cumulativeCount integer
month string(date)

DataCompletionStatistics

Name Type
completionOverTime Array<CountsPerMonth>
mostIncompleteCategories Array<IncompleteCategory>
overallCompletion number
totalCases integer

DataPlatformStatistics

Name Type
cases integer
clinicalCenters integer
cohorts integer
contributors integer
entries integer
mutations integer
primarySites integer
projects integer

DataResource

Type: string

Dataset

Name Type
cohortsIds Array<string>
createdAt string(date-time)
createdBy string
description string
externalSource string
externalSourceId string
id string(uuid)
lastExport string(date-time)
name string
projectId string(uuid)
rules Array<DatasetRule>
summary string
totalExports integer
updatedAt string(date-time)
updatedBy Array<string>

DatasetCreate

Name Type
externalSource string
externalSourceId string
name string
projectId string(uuid)
rules Array<DatasetRule>
summary string

DatasetFilters

Name Type
cohortsIds string
cohortsIds.anyOf Array<string>
cohortsIds.beginsWith string
cohortsIds.contains string
cohortsIds.endsWith string
cohortsIds.not string
cohortsIds.not.anyOf Array<string>
cohortsIds.not.beginsWith string
cohortsIds.not.contains string
cohortsIds.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
createdBy string
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
lastExport.after string(date)
lastExport.before string(date)
lastExport.between Array<>
lastExport.exists boolean
lastExport.not.between Array<>
lastExport.not.exists boolean
lastExport.not.on string(date)
lastExport.on string(date)
lastExport.onOrAfter string(date)
lastExport.onOrBefore string(date)
name string
name.anyOf Array<string>
name.beginsWith string
name.contains string
name.endsWith string
name.not string
name.not.anyOf Array<string>
name.not.beginsWith string
name.not.contains string
name.not.endsWith string
projectId string
projectId.anyOf Array<string>
projectId.beginsWith string
projectId.contains string
projectId.endsWith string
projectId.not string
projectId.not.anyOf Array<string>
projectId.not.beginsWith string
projectId.not.contains string
projectId.not.endsWith string
rules.field string
rules.field.anyOf Array<string>
rules.field.beginsWith string
rules.field.contains string
rules.field.endsWith string
rules.field.not string
rules.field.not.anyOf Array<string>
rules.field.not.beginsWith string
rules.field.not.contains string
rules.field.not.endsWith string
rules.resource
rules.resource.anyOf Array<string>
rules.resource.not
rules.transform string
rules.transform.anyOf Array<string>
rules.transform.beginsWith string
rules.transform.contains string
rules.transform.endsWith string
rules.transform.exists boolean
rules.transform.not string
rules.transform.not.anyOf Array<string>
rules.transform.not.beginsWith string
rules.transform.not.contains string
rules.transform.not.endsWith string
rules.transform.not.exists boolean
summary string
summary.anyOf Array<string>
summary.beginsWith string
summary.contains string
summary.endsWith string
summary.exists boolean
summary.not string
summary.not.anyOf Array<string>
summary.not.beginsWith string
summary.not.contains string
summary.not.endsWith string
summary.not.exists boolean
totalExports.between Array<>
totalExports.equal integer
totalExports.greaterThan integer
totalExports.greaterThanOrEqual integer
totalExports.lessThan integer
totalExports.lessThanOrEqual integer
totalExports.not.between Array<>
totalExports.not.equal integer
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

DatasetRule

Name Type
field string
resource DataResource
transform

Distribution

Name Type
items Array<CohortTraitCounts>
metadata

DNAChangeType

Type: string

EntityStatistics

Name Type
dataCompletionMedian number
population integer
topographyCode string
topographyGroup string

ExportedCohortDefinition

Name Type
checksum string
definition CohortCreate
exportedAt string(date-time)
exportedBy string
exportVersion string

ExportedPatientCaseDataset

Name Type
checksum string
dataset Array<PatientCaseDataset>
exportedAt string(date-time)
exportedBy string
exportVersion string

FamilyHistory

Name Type
anonymized boolean
caseId string(uuid)
contributedToDeath boolean
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
hadCancer boolean
id string(uuid)
morphology
onsetAge integer
relationship CodedConcept
topography
updatedAt string(date-time)
updatedBy Array<string>

FamilyHistoryCreate

Name Type
caseId string(uuid)
contributedToDeath boolean
date string(date)
externalSource string
externalSourceId string
hadCancer boolean
morphology
onsetAge integer
relationship CodedConcept
topography

FamilyHistoryFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
contributedToDeath boolean
contributedToDeath.exists boolean
contributedToDeath.not.exists boolean
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
hadCancer boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
morphology string
morphology.anyOf Array<string>
morphology.descendantsOf string
morphology.exists boolean
morphology.not string
morphology.not.anyOf Array<string>
morphology.not.exists boolean
onsetAge.between Array<>
onsetAge.equal integer
onsetAge.exists boolean
onsetAge.greaterThan integer
onsetAge.greaterThanOrEqual integer
onsetAge.lessThan integer
onsetAge.lessThanOrEqual integer
onsetAge.not.between Array<>
onsetAge.not.equal integer
onsetAge.not.exists boolean
relationship string
relationship.anyOf Array<string>
relationship.descendantsOf string
relationship.not string
relationship.not.anyOf Array<string>
topography string
topography.anyOf Array<string>
topography.descendantsOf string
topography.exists boolean
topography.not string
topography.not.anyOf Array<string>
topography.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

FamilyHistoryPartial

Name Type
anonymized boolean
caseId string(uuid)
contributedToDeath boolean
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
hadCancer boolean
id string(uuid)
morphology
onsetAge integer
relationship
topography
updatedAt string(date-time)
updatedBy Array<string>

FIGOStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
methodology
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

FIGOStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
methodology
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

GenomicSignatureFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
category
category.anyOf Array<string>
category.not
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

GenomicSignatureTypes

Type: string

GenomicVariant

Name Type
alleleDepth integer
alleleFrequency number
analysisMethod
anonymized boolean
assessment
assessmentDate string(date)
caseId string(uuid)
clinicalRelevance
clinvar string
confidence
coordinateSystem
copyNumber integer
createdAt string(date-time)
createdBy string
date string(date)
description string
dnaChangePosition integer
dnaChangePositionRange
dnaChangeType
dnaHgvs string
dnaReferenceSequence string
externalSource string
externalSourceId string
genePanel string
genes Array<CodedConcept>
genomeAssemblyVersion
id string(uuid)
inheritance
isPathogenic boolean
isVUS boolean
molecularConsequence
nucleotidesLength integer
proteinChangeType
proteinHgvs string
proteinReferenceSequence string
regions Array<string>
rnaChangePosition string
rnaChangeType
rnaHgvs string
rnaReferenceSequence string
updatedAt string(date-time)
updatedBy Array<string>
zygosity

GenomicVariantAssessmentChoices

Type: string

GenomicVariantClinicalRelevanceChoices

Type: string

GenomicVariantConfidenceChoices

Type: string

GenomicVariantCreate

Name Type
alleleDepth integer
alleleFrequency number
analysisMethod
assessment
assessmentDate string(date)
caseId string(uuid)
clinicalRelevance
clinvar string
confidence
coordinateSystem
copyNumber integer
date string(date)
dnaHgvs string
externalSource string
externalSourceId string
genePanel string
genes Array<CodedConcept>
genomeAssemblyVersion
inheritance
molecularConsequence
proteinHgvs string
rnaHgvs string
zygosity

GenomicVariantFilters

Name Type
alleleDepth.between Array<>
alleleDepth.equal integer
alleleDepth.exists boolean
alleleDepth.greaterThan integer
alleleDepth.greaterThanOrEqual integer
alleleDepth.lessThan integer
alleleDepth.lessThanOrEqual integer
alleleDepth.not.between Array<>
alleleDepth.not.equal integer
alleleDepth.not.exists boolean
alleleFrequency.between Array<>
alleleFrequency.equal number
alleleFrequency.exists boolean
alleleFrequency.greaterThan number
alleleFrequency.greaterThanOrEqual number
alleleFrequency.lessThan number
alleleFrequency.lessThanOrEqual number
alleleFrequency.not.between Array<>
alleleFrequency.not.equal number
alleleFrequency.not.exists boolean
analysisMethod string
analysisMethod.anyOf Array<string>
analysisMethod.descendantsOf string
analysisMethod.exists boolean
analysisMethod.not string
analysisMethod.not.anyOf Array<string>
analysisMethod.not.exists boolean
assessment
assessment.anyOf Array<string>
assessment.exists boolean
assessment.not
assessment.not.exists boolean
assessmentDate.after string(date)
assessmentDate.before string(date)
assessmentDate.between Array<>
assessmentDate.exists boolean
assessmentDate.not.between Array<>
assessmentDate.not.exists boolean
assessmentDate.not.on string(date)
assessmentDate.on string(date)
assessmentDate.onOrAfter string(date)
assessmentDate.onOrBefore string(date)
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
clinicalRelevance
clinicalRelevance.anyOf Array<string>
clinicalRelevance.exists boolean
clinicalRelevance.not
clinicalRelevance.not.exists boolean
clinvar string
clinvar.anyOf Array<string>
clinvar.beginsWith string
clinvar.contains string
clinvar.endsWith string
clinvar.exists boolean
clinvar.not string
clinvar.not.anyOf Array<string>
clinvar.not.beginsWith string
clinvar.not.contains string
clinvar.not.endsWith string
clinvar.not.exists boolean
confidence
confidence.anyOf Array<string>
confidence.exists boolean
confidence.not
confidence.not.exists boolean
coordinateSystem string
coordinateSystem.anyOf Array<string>
coordinateSystem.descendantsOf string
coordinateSystem.exists boolean
coordinateSystem.not string
coordinateSystem.not.anyOf Array<string>
coordinateSystem.not.exists boolean
copyNumber.between Array<>
copyNumber.equal integer
copyNumber.exists boolean
copyNumber.greaterThan integer
copyNumber.greaterThanOrEqual integer
copyNumber.lessThan integer
copyNumber.lessThanOrEqual integer
copyNumber.not.between Array<>
copyNumber.not.equal integer
copyNumber.not.exists boolean
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
dnaChangePosition.between Array<>
dnaChangePosition.equal integer
dnaChangePosition.exists boolean
dnaChangePosition.greaterThan integer
dnaChangePosition.greaterThanOrEqual integer
dnaChangePosition.lessThan integer
dnaChangePosition.lessThanOrEqual integer
dnaChangePosition.not.between Array<>
dnaChangePosition.not.equal integer
dnaChangePosition.not.exists boolean
dnaChangePositionRange.containedBy Array<>
dnaChangePositionRange.contains Array<>
dnaChangePositionRange.exists boolean
dnaChangePositionRange.not.containedBy Array<>
dnaChangePositionRange.not.contains Array<>
dnaChangePositionRange.not.exists boolean
dnaChangePositionRange.not.overlaps Array<>
dnaChangePositionRange.overlaps Array<>
dnaChangeType
dnaChangeType.anyOf Array<string>
dnaChangeType.exists boolean
dnaChangeType.not
dnaChangeType.not.exists boolean
dnaHgvs string
dnaHgvs.anyOf Array<string>
dnaHgvs.beginsWith string
dnaHgvs.contains string
dnaHgvs.endsWith string
dnaHgvs.exists boolean
dnaHgvs.not string
dnaHgvs.not.anyOf Array<string>
dnaHgvs.not.beginsWith string
dnaHgvs.not.contains string
dnaHgvs.not.endsWith string
dnaHgvs.not.exists boolean
dnaReferenceSequence string
dnaReferenceSequence.anyOf Array<string>
dnaReferenceSequence.beginsWith string
dnaReferenceSequence.contains string
dnaReferenceSequence.endsWith string
dnaReferenceSequence.exists boolean
dnaReferenceSequence.not string
dnaReferenceSequence.not.anyOf Array<string>
dnaReferenceSequence.not.beginsWith string
dnaReferenceSequence.not.contains string
dnaReferenceSequence.not.endsWith string
dnaReferenceSequence.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
genePanel string
genePanel.anyOf Array<string>
genePanel.beginsWith string
genePanel.contains string
genePanel.endsWith string
genePanel.exists boolean
genePanel.not string
genePanel.not.anyOf Array<string>
genePanel.not.beginsWith string
genePanel.not.contains string
genePanel.not.endsWith string
genePanel.not.exists boolean
genes string
genes.allOf Array<string>
genes.anyOf Array<string>
genes.descendantsOf string
genes.not string
genes.not.allOf Array<string>
genes.not.anyOf Array<string>
genomeAssemblyVersion string
genomeAssemblyVersion.anyOf Array<string>
genomeAssemblyVersion.descendantsOf string
genomeAssemblyVersion.exists boolean
genomeAssemblyVersion.not string
genomeAssemblyVersion.not.anyOf Array<string>
genomeAssemblyVersion.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
inheritance string
inheritance.anyOf Array<string>
inheritance.descendantsOf string
inheritance.exists boolean
inheritance.not string
inheritance.not.anyOf Array<string>
inheritance.not.exists boolean
isPathogenic boolean
isPathogenic.exists boolean
isPathogenic.not.exists boolean
isVUS boolean
isVUS.exists boolean
isVUS.not.exists boolean
molecularConsequence string
molecularConsequence.anyOf Array<string>
molecularConsequence.descendantsOf string
molecularConsequence.exists boolean
molecularConsequence.not string
molecularConsequence.not.anyOf Array<string>
molecularConsequence.not.exists boolean
nucleotidesLength.between Array<>
nucleotidesLength.equal integer
nucleotidesLength.exists boolean
nucleotidesLength.greaterThan integer
nucleotidesLength.greaterThanOrEqual integer
nucleotidesLength.lessThan integer
nucleotidesLength.lessThanOrEqual integer
nucleotidesLength.not.between Array<>
nucleotidesLength.not.equal integer
nucleotidesLength.not.exists boolean
proteinChangeType
proteinChangeType.anyOf Array<string>
proteinChangeType.exists boolean
proteinChangeType.not
proteinChangeType.not.exists boolean
proteinHgvs string
proteinHgvs.anyOf Array<string>
proteinHgvs.beginsWith string
proteinHgvs.contains string
proteinHgvs.endsWith string
proteinHgvs.exists boolean
proteinHgvs.not string
proteinHgvs.not.anyOf Array<string>
proteinHgvs.not.beginsWith string
proteinHgvs.not.contains string
proteinHgvs.not.endsWith string
proteinHgvs.not.exists boolean
proteinReferenceSequence string
proteinReferenceSequence.anyOf Array<string>
proteinReferenceSequence.beginsWith string
proteinReferenceSequence.contains string
proteinReferenceSequence.endsWith string
proteinReferenceSequence.exists boolean
proteinReferenceSequence.not string
proteinReferenceSequence.not.anyOf Array<string>
proteinReferenceSequence.not.beginsWith string
proteinReferenceSequence.not.contains string
proteinReferenceSequence.not.endsWith string
proteinReferenceSequence.not.exists boolean
regions string
regions.anyOf Array<string>
regions.beginsWith string
regions.contains string
regions.endsWith string
regions.exists boolean
regions.not string
regions.not.anyOf Array<string>
regions.not.beginsWith string
regions.not.contains string
regions.not.endsWith string
regions.not.exists boolean
rnaChangePosition string
rnaChangePosition.anyOf Array<string>
rnaChangePosition.beginsWith string
rnaChangePosition.contains string
rnaChangePosition.endsWith string
rnaChangePosition.exists boolean
rnaChangePosition.not string
rnaChangePosition.not.anyOf Array<string>
rnaChangePosition.not.beginsWith string
rnaChangePosition.not.contains string
rnaChangePosition.not.endsWith string
rnaChangePosition.not.exists boolean
rnaChangeType
rnaChangeType.anyOf Array<string>
rnaChangeType.exists boolean
rnaChangeType.not
rnaChangeType.not.exists boolean
rnaHgvs string
rnaHgvs.anyOf Array<string>
rnaHgvs.beginsWith string
rnaHgvs.contains string
rnaHgvs.endsWith string
rnaHgvs.exists boolean
rnaHgvs.not string
rnaHgvs.not.anyOf Array<string>
rnaHgvs.not.beginsWith string
rnaHgvs.not.contains string
rnaHgvs.not.endsWith string
rnaHgvs.not.exists boolean
rnaReferenceSequence string
rnaReferenceSequence.anyOf Array<string>
rnaReferenceSequence.beginsWith string
rnaReferenceSequence.contains string
rnaReferenceSequence.endsWith string
rnaReferenceSequence.exists boolean
rnaReferenceSequence.not string
rnaReferenceSequence.not.anyOf Array<string>
rnaReferenceSequence.not.beginsWith string
rnaReferenceSequence.not.contains string
rnaReferenceSequence.not.endsWith string
rnaReferenceSequence.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)
zygosity string
zygosity.anyOf Array<string>
zygosity.descendantsOf string
zygosity.exists boolean
zygosity.not string
zygosity.not.anyOf Array<string>
zygosity.not.exists boolean

GenomicVariantPartial

Name Type
alleleDepth integer
alleleFrequency number
analysisMethod
anonymized boolean
assessment
assessmentDate string(date)
caseId string(uuid)
clinicalRelevance
clinvar string
confidence
coordinateSystem
copyNumber integer
createdAt string(date-time)
createdBy string
date string(date)
dnaChangePosition integer
dnaChangePositionRange
dnaChangeType
dnaHgvs string
dnaReferenceSequence string
externalSource string
externalSourceId string
genePanel string
genes
genomeAssemblyVersion
id string(uuid)
inheritance
isPathogenic boolean
isVUS boolean
molecularConsequence
nucleotidesLength integer
proteinChangeType
proteinHgvs string
proteinReferenceSequence string
regions Array<string>
rnaChangePosition string
rnaChangeType
rnaHgvs string
rnaReferenceSequence string
updatedAt string(date-time)
updatedBy Array<string>
zygosity

GleasonGrade

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

GleasonGradeCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

GleasonGradePartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

HealthCheck

Name Type
database
database_connection_time_ms
migrations
server string

HistoryEvent

Name Type
category HistoryEventCategory
context
differential
id
resource string
resourceId
snapshot
timestamp string(date-time)
url string
user string

HistoryEventCategory

Type: string

HistoryEventWithSchema

Name Type
category HistoryEventCategory
context
differential
id
resource string
resourceId
snapshot
timestamp string(date-time)
url string
user string

HomologousRecombinationDeficiency

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
interpretation
updatedAt string(date-time)
updatedBy Array<string>
value number

HomologousRecombinationDeficiencyCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
interpretation
value number

HomologousRecombinationDeficiencyInterpretationChoices

Type: string

HomologousRecombinationDeficiencyPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
interpretation
updatedAt string(date-time)
updatedBy Array<string>
value number

IncompleteCategory

Name Type
affectedSites Array<CodedConcept>
cases integer
category string

Input

Name Type
limit integer
offset integer

INRGSSStage

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

INRGSSStageCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

INRGSSStagePartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

INSSStage

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

INSSStageCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

INSSStagePartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

ISSStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

ISSStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

ISSStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

KaplanMeierCurve

Name Type
lowerConfidenceBand Array<number>
metadata
months Array<number>
probabilities Array<number>
upperConfidenceBand Array<number>

Lifestyle

Name Type
alcoholConsumption
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
exposures Array<CodedConcept>
externalSource string
externalSourceId string
id string(uuid)
nightSleep
recreationalDrugs Array<CodedConcept>
smokingPackyears number
smokingQuited
smokingStatus
updatedAt string(date-time)
updatedBy Array<string>

LifestyleCreate

Name Type
alcoholConsumption
caseId string(uuid)
date string(date)
exposures Array<CodedConcept>
externalSource string
externalSourceId string
nightSleep
recreationalDrugs Array<CodedConcept>
smokingPackyears number
smokingQuited
smokingStatus

LifestyleFilters

Name Type
alcoholConsumption string
alcoholConsumption.anyOf Array<string>
alcoholConsumption.descendantsOf string
alcoholConsumption.exists boolean
alcoholConsumption.not string
alcoholConsumption.not.anyOf Array<string>
alcoholConsumption.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
exposures string
exposures.allOf Array<string>
exposures.anyOf Array<string>
exposures.descendantsOf string
exposures.exists boolean
exposures.not string
exposures.not.allOf Array<string>
exposures.not.anyOf Array<string>
exposures.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
nightSleep.between Array<>
nightSleep.equal number
nightSleep.exists boolean
nightSleep.greaterThan number
nightSleep.greaterThanOrEqual number
nightSleep.lessThan number
nightSleep.lessThanOrEqual number
nightSleep.not.between Array<>
nightSleep.not.equal number
nightSleep.not.exists boolean
recreationalDrugs string
recreationalDrugs.allOf Array<string>
recreationalDrugs.anyOf Array<string>
recreationalDrugs.descendantsOf string
recreationalDrugs.exists boolean
recreationalDrugs.not string
recreationalDrugs.not.allOf Array<string>
recreationalDrugs.not.anyOf Array<string>
recreationalDrugs.not.exists boolean
smokingPackyears.between Array<>
smokingPackyears.equal number
smokingPackyears.exists boolean
smokingPackyears.greaterThan number
smokingPackyears.greaterThanOrEqual number
smokingPackyears.lessThan number
smokingPackyears.lessThanOrEqual number
smokingPackyears.not.between Array<>
smokingPackyears.not.equal number
smokingPackyears.not.exists boolean
smokingQuited.between Array<>
smokingQuited.equal number
smokingQuited.exists boolean
smokingQuited.greaterThan number
smokingQuited.greaterThanOrEqual number
smokingQuited.lessThan number
smokingQuited.lessThanOrEqual number
smokingQuited.not.between Array<>
smokingQuited.not.equal number
smokingQuited.not.exists boolean
smokingStatus string
smokingStatus.anyOf Array<string>
smokingStatus.descendantsOf string
smokingStatus.exists boolean
smokingStatus.not string
smokingStatus.not.anyOf Array<string>
smokingStatus.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

LifestylePartial

Name Type
alcoholConsumption
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
exposures
externalSource string
externalSourceId string
id string(uuid)
nightSleep
recreationalDrugs
smokingPackyears number
smokingQuited
smokingStatus
updatedAt string(date-time)
updatedBy Array<string>

LossOfHeterozygosity

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value number

LossOfHeterozygosityCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
value number

LossOfHeterozygosityPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value number

LymphomaStaging

Name Type
anonymized boolean
bulky boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
methodology
modifiers Array<CodedConcept>
pathological boolean
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

LymphomaStagingCreate

Name Type
bulky boolean
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
methodology
modifiers Array<CodedConcept>
pathological boolean
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

LymphomaStagingPartial

Name Type
anonymized boolean
bulky boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
methodology
modifiers
pathological boolean
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

Measure

Name Type
unit string
value number

MeasureConversion

Name Type
newUnit string
unit string
value number

MicrosatelliteInstability

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value CodedConcept

MicrosatelliteInstabilityCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
value CodedConcept

MicrosatelliteInstabilityPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value

ModifiedResource

Name Type
description string
id string(uuid)

MolecularTherapeuticRecommendation

Name Type
clinicalTrial string
createdAt string(date-time)
createdBy string
description string
drugs Array<CodedConcept>
expectedEffect
externalSource string
externalSourceId string
id string(uuid)
offLabelUse boolean
supportingGenomicSignaturesIds Array<string(uuid)>
supportingGenomicVariantsIds Array<string(uuid)>
supportingTumorMarkersIds Array<string(uuid)>
updatedAt string(date-time)
updatedBy Array<string>
withinSoc boolean

MolecularTherapeuticRecommendationCreate

Name Type
clinicalTrial string
drugs Array<CodedConcept>
expectedEffect
externalSource string
externalSourceId string
offLabelUse boolean
supportingGenomicSignaturesIds Array<string(uuid)>
supportingGenomicVariantsIds Array<string(uuid)>
supportingTumorMarkersIds Array<string(uuid)>
withinSoc boolean

MolecularTumorBoard

Name Type
anonymized boolean
caseId string(uuid)
category string
characterizedCup boolean
conductedCupCharacterization boolean
conductedMolecularComparison boolean
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
molecularComparisonMatchId string(uuid)
recommendations Array<CodedConcept>
relatedEntitiesIds Array<string(uuid)>
reviewedReports Array<string>
therapeuticRecommendations Array<MolecularTherapeuticRecommendation>
updatedAt string(date-time)
updatedBy Array<string>

MolecularTumorBoardCreate

Name Type
caseId string(uuid)
category string
characterizedCup boolean
conductedCupCharacterization boolean
conductedMolecularComparison boolean
date string(date)
externalSource string
externalSourceId string
molecularComparisonMatchId string(uuid)
recommendations Array<CodedConcept>
relatedEntitiesIds Array<string(uuid)>
reviewedReports Array<string>

NeoplasticEntity

Name Type
anonymized boolean
assertionDate string(date)
caseId string(uuid)
createdAt string(date-time)
createdBy string
description string
differentitation
externalSource string
externalSourceId string
id string(uuid)
laterality
morphology CodedConcept
relatedPrimaryId string(uuid)
relationship NeoplasticEntityRelationshipChoices
topography CodedConcept
topographyGroup
updatedAt string(date-time)
updatedBy Array<string>

NeoplasticEntityCreate

Name Type
assertionDate string(date)
caseId string(uuid)
differentitation
externalSource string
externalSourceId string
laterality
morphology CodedConcept
relatedPrimaryId string(uuid)
relationship NeoplasticEntityRelationshipChoices
topography CodedConcept

NeoplasticEntityFilters

Name Type
assertionDate.after string(date)
assertionDate.before string(date)
assertionDate.between Array<>
assertionDate.not.between Array<>
assertionDate.not.on string(date)
assertionDate.on string(date)
assertionDate.onOrAfter string(date)
assertionDate.onOrBefore string(date)
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
differentitation string
differentitation.anyOf Array<string>
differentitation.descendantsOf string
differentitation.exists boolean
differentitation.not string
differentitation.not.anyOf Array<string>
differentitation.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
laterality string
laterality.anyOf Array<string>
laterality.descendantsOf string
laterality.exists boolean
laterality.not string
laterality.not.anyOf Array<string>
laterality.not.exists boolean
morphology string
morphology.anyOf Array<string>
morphology.descendantsOf string
morphology.not string
morphology.not.anyOf Array<string>
relatedPrimaryId string
relatedPrimaryId.anyOf Array<string>
relatedPrimaryId.beginsWith string
relatedPrimaryId.contains string
relatedPrimaryId.endsWith string
relatedPrimaryId.exists boolean
relatedPrimaryId.not string
relatedPrimaryId.not.anyOf Array<string>
relatedPrimaryId.not.beginsWith string
relatedPrimaryId.not.contains string
relatedPrimaryId.not.endsWith string
relatedPrimaryId.not.exists boolean
relationship
relationship.anyOf Array<string>
relationship.not
topography string
topography.anyOf Array<string>
topography.descendantsOf string
topography.not string
topography.not.anyOf Array<string>
topographyGroup string
topographyGroup.anyOf Array<string>
topographyGroup.descendantsOf string
topographyGroup.exists boolean
topographyGroup.not string
topographyGroup.not.anyOf Array<string>
topographyGroup.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

NeoplasticEntityPartial

Name Type
anonymized boolean
assertionDate string(date)
caseId string(uuid)
createdAt string(date-time)
createdBy string
differentitation
externalSource string
externalSourceId string
id string(uuid)
laterality
morphology
relatedPrimaryId string(uuid)
relationship
topography
topographyGroup
updatedAt string(date-time)
updatedBy Array<string>

NeoplasticEntityRelationshipChoices

Type: string

ninja__pagination__LimitOffsetPagination__Input

Name Type
limit integer
offset integer

ninja_extra__ordering__Ordering__Input

Name Type
ordering

onconova__core__anonymization__decorator__AnonymizationBase__Input

Name Type
anonymized boolean

OncoplotDataset

Name Type
cases Array<string>
genes Array<string>
metadata
variants Array<OncoplotVariant>

OncoplotVariant

Name Type
caseId string
gene string
hgvsExpression string
isPathogenic boolean

Paginated_AdverseEvent_

Name Type
count integer
items Array<AdverseEvent>

Paginated_AnyGenomicSignature_

Name Type
count integer
items Array<AnyGenomicSignature>

Paginated_AnyStaging_

Name Type
count integer
items Array<AnyStaging>

Paginated_AnyTumorBoard_

Name Type
count integer
items Array<AnyTumorBoard>

Paginated_CodedConcept_

Name Type
count integer
items Array<CodedConcept>

Paginated_Cohort_

Name Type
count integer
items Array<Cohort>

Paginated_ComorbiditiesAssessment_

Name Type
count integer
items Array<ComorbiditiesAssessment>

Paginated_Dataset_

Name Type
count integer
items Array<Dataset>

Paginated_FamilyHistory_

Name Type
count integer
items Array<FamilyHistory>

Paginated_GenomicVariant_

Name Type
count integer
items Array<GenomicVariant>

Paginated_HistoryEvent_

Name Type
count integer
items Array<HistoryEvent>

Paginated_HistoryEventWithSchema_

Name Type
count integer
items Array<HistoryEventWithSchema>

Paginated_Lifestyle_

Name Type
count integer
items Array<Lifestyle>

Paginated_NeoplasticEntity_

Name Type
count integer
items Array<NeoplasticEntity>

Paginated_PatientCase_

Name Type
count integer
items Array<PatientCase>

Paginated_PatientCaseDataset_

Name Type
count integer
items Array<PatientCaseDataset>

Paginated_PerformanceStatus_

Name Type
count integer
items Array<PerformanceStatus>

Paginated_Project_

Name Type
count integer
items Array<Project>

Paginated_ProjectDataManagerGrant_

Name Type
count integer
items Array<ProjectDataManagerGrant>

Paginated_Radiotherapy_

Name Type
count integer
items Array<Radiotherapy>

Paginated_RiskAssessment_

Name Type
count integer
items Array<RiskAssessment>

Paginated_Surgery_

Name Type
count integer
items Array<Surgery>

Paginated_SystemicTherapy_

Name Type
count integer
items Array<SystemicTherapy>

Paginated_TherapyLine_

Name Type
count integer
items Array<TherapyLine>

Paginated_TreatmentResponse_

Name Type
count integer
items Array<TreatmentResponse>

Paginated_TumorMarker_

Name Type
count integer
items Array<TumorMarker>

Paginated_User_

Name Type
count integer
items Array<User>

Paginated_Vitals_

Name Type
count integer
items Array<Vitals>

PatientCase

Name Type
age
ageAtDiagnosis
anonymized boolean
causeOfDeath
clinicalCenter string
clinicalIdentifier string
consentStatus
contributors Array<string>
createdAt string(date-time)
createdBy string
dataCompletionRate number
dateOfBirth
dateOfDeath string(date)
description string
endOfRecords string(date)
externalSource string
externalSourceId string
gender CodedConcept
genderIdentity
id string(uuid)
overallSurvival number
pseudoidentifier string
race
sexAtBirth
updatedAt string(date-time)
updatedBy Array<string>
vitalStatus

PatientCaseBundle

Name Type
adverseEvents Array<AdverseEvent>
age
ageAtDiagnosis
anonymized boolean
causeOfDeath
clinicalCenter string
clinicalIdentifier string
comorbidities Array<ComorbiditiesAssessment>
completedDataCategories
consentStatus
contributors Array<string>
contributorsDetails Array<UserExport>
createdAt string(date-time)
createdBy string
dataCompletionRate number
dateOfBirth
dateOfDeath string(date)
description string
endOfRecords string(date)
externalSource string
externalSourceId string
familyHistory Array<FamilyHistory>
gender CodedConcept
genderIdentity
genomicSignatures Array<>
genomicVariants Array<GenomicVariant>
history Array<HistoryEvent>
id string(uuid)
lifestyles Array<Lifestyle>
neoplasticEntities Array<NeoplasticEntity>
overallSurvival number
performanceStatus Array<PerformanceStatus>
pseudoidentifier string
race
radiotherapies Array<Radiotherapy>
riskAssessments Array<RiskAssessment>
sexAtBirth
stagings Array<>
surgeries Array<Surgery>
systemicTherapies Array<SystemicTherapy>
therapyLines Array<TherapyLine>
treatmentResponses Array<TreatmentResponse>
tumorBoards Array<>
tumorMarkers Array<TumorMarker>
updatedAt string(date-time)
updatedBy Array<string>
vitals Array<Vitals>
vitalStatus

PatientCaseConsentStatusChoices

Type: string

PatientCaseCreate

Name Type
causeOfDeath
clinicalCenter string
clinicalIdentifier string
consentStatus
dateOfBirth string(date)
dateOfDeath string(date)
endOfRecords string(date)
externalSource string
externalSourceId string
gender CodedConcept
genderIdentity
race
sexAtBirth
vitalStatus

PatientCaseDataCategoryChoices

Type: string

PatientCaseDataCompletionStatus

Name Type
status boolean
timestamp string(date-time)
username string

PatientCaseDataset

Name Type
adverseEvents Array<AdverseEventPartial>
age
ageAtDiagnosis
aneuploidScores Array<AneuploidScorePartial>
anonymized boolean
binetStagings Array<BinetStagingPartial>
breslowStagings Array<BreslowDepthPartial>
causeOfDeath
clarkStagings Array<ClarkStagingPartial>
clinicalCenter string
clinicalIdentifier string
comorbidities Array<ComorbiditiesAssessmentPartial>
consentStatus
contributors Array<string>
createdAt string(date-time)
createdBy string
dataCompletionRate number
dateOfBirth
dateOfDeath string(date)
endOfRecords string(date)
externalSource string
externalSourceId string
familyHistory Array<FamilyHistoryPartial>
figoStagings Array<TNMStagingPartial>
gender
genderIdentity
genomicVariants Array<GenomicVariantPartial>
gleasonStagings Array<GleasonGradePartial>
homologousRecombinationDeficiencies Array<HomologousRecombinationDeficiencyPartial>
id string(uuid)
inrgssStagings Array<INRGSSStagePartial>
inssStagings Array<INSSStagePartial>
issStagings Array<ISSStagingPartial>
lifestyles Array<LifestylePartial>
lossesOfHeterozygosity Array<LossOfHeterozygosityPartial>
lymphomaStagings Array<LymphomaStagingPartial>
microsatelliteInstabilities Array<MicrosatelliteInstabilityPartial>
molecularTumorBoards Array<UnspecifiedTumorBoardPartial>
neoplasticEntities Array<NeoplasticEntityPartial>
overallSurvival number
performanceStatus Array<PerformanceStatusPartial>
pseudoidentifier string
race
radiotherapies Array<RadiotherapyPartial>
raiStagings Array<RaiStagingPartial>
rhabdomyosarcomaGroups Array<RhabdomyosarcomaClinicalGroupPartial>
riskAssessments Array<RiskAssessmentPartial>
rissStagings Array<RISSStagingPartial>
sexAtBirth
surgeries Array<SurgeryPartial>
systemicTherapies Array<SystemicTherapyPartial>
therapyLines Array<TherapyLinePartial>
tnmStagings Array<TNMStagingPartial>
treatmentResponses Array<TreatmentResponsePartial>
tumorMarkers Array<TumorMarkerPartial>
tumorMutationalBurdens Array<TumorMutationalBurdenPartial>
tumorNeoantigenBurdens Array<TumorNeoantigenBurdenPartial>
unspecifiedTumorBoards Array<UnspecifiedTumorBoardPartial>
updatedAt string(date-time)
updatedBy Array<string>
vitals Array<VitalsPartial>
vitalStatus
wilmsStagings Array<WilmsStagePartial>

PatientCaseFilters

Name Type
age.between Array<>
age.equal integer
age.greaterThan integer
age.greaterThanOrEqual integer
age.lessThan integer
age.lessThanOrEqual integer
age.not.between Array<>
age.not.equal integer
ageAtDiagnosis.between Array<>
ageAtDiagnosis.equal integer
ageAtDiagnosis.exists boolean
ageAtDiagnosis.greaterThan integer
ageAtDiagnosis.greaterThanOrEqual integer
ageAtDiagnosis.lessThan integer
ageAtDiagnosis.lessThanOrEqual integer
ageAtDiagnosis.not.between Array<>
ageAtDiagnosis.not.equal integer
ageAtDiagnosis.not.exists boolean
causeOfDeath string
causeOfDeath.anyOf Array<string>
causeOfDeath.descendantsOf string
causeOfDeath.exists boolean
causeOfDeath.not string
causeOfDeath.not.anyOf Array<string>
causeOfDeath.not.exists boolean
consentStatus
consentStatus.anyOf Array<string>
consentStatus.not
contributors Array<string>
contributors.containedBy Array<string>
contributors.contains Array<string>
contributors.not Array<string>
contributors.not.containedBy Array<string>
contributors.not.contains Array<string>
contributors.not.overlaps Array<string>
contributors.overlaps Array<string>
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
dataCompletionRate.between Array<>
dataCompletionRate.equal number
dataCompletionRate.greaterThan number
dataCompletionRate.greaterThanOrEqual number
dataCompletionRate.lessThan number
dataCompletionRate.lessThanOrEqual number
dataCompletionRate.not.between Array<>
dataCompletionRate.not.equal number
endOfRecords.after string(date)
endOfRecords.before string(date)
endOfRecords.between Array<>
endOfRecords.exists boolean
endOfRecords.not.between Array<>
endOfRecords.not.exists boolean
endOfRecords.not.on string(date)
endOfRecords.on string(date)
endOfRecords.onOrAfter string(date)
endOfRecords.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
gender string
gender.anyOf Array<string>
gender.descendantsOf string
gender.not string
gender.not.anyOf Array<string>
genderIdentity string
genderIdentity.anyOf Array<string>
genderIdentity.descendantsOf string
genderIdentity.exists boolean
genderIdentity.not string
genderIdentity.not.anyOf Array<string>
genderIdentity.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
morphology string
overallSurvival.between Array<>
overallSurvival.equal number
overallSurvival.exists boolean
overallSurvival.greaterThan number
overallSurvival.greaterThanOrEqual number
overallSurvival.lessThan number
overallSurvival.lessThanOrEqual number
overallSurvival.not.between Array<>
overallSurvival.not.equal number
overallSurvival.not.exists boolean
primarySite string
pseudoidentifier string
pseudoidentifier.anyOf Array<string>
pseudoidentifier.beginsWith string
pseudoidentifier.contains string
pseudoidentifier.endsWith string
pseudoidentifier.not string
pseudoidentifier.not.anyOf Array<string>
pseudoidentifier.not.beginsWith string
pseudoidentifier.not.contains string
pseudoidentifier.not.endsWith string
race string
race.anyOf Array<string>
race.descendantsOf string
race.exists boolean
race.not string
race.not.anyOf Array<string>
race.not.exists boolean
sexAtBirth string
sexAtBirth.anyOf Array<string>
sexAtBirth.descendantsOf string
sexAtBirth.exists boolean
sexAtBirth.not string
sexAtBirth.not.anyOf Array<string>
sexAtBirth.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)
vitalStatus
vitalStatus.anyOf Array<string>
vitalStatus.not

PatientCaseIdentifier

Type: string

PatientCaseVitalStatusChoices

Type: string

PerformanceStatus

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
ecogInterpretation
ecogScore integer
externalSource string
externalSourceId string
id string(uuid)
karnofskyInterpretation
karnofskyScore integer
updatedAt string(date-time)
updatedBy Array<string>

PerformanceStatusCreate

Name Type
caseId string(uuid)
date string(date)
ecogScore integer
externalSource string
externalSourceId string
karnofskyScore integer

PerformanceStatusFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
ecogInterpretation string
ecogInterpretation.anyOf Array<string>
ecogInterpretation.descendantsOf string
ecogInterpretation.exists boolean
ecogInterpretation.not string
ecogInterpretation.not.anyOf Array<string>
ecogInterpretation.not.exists boolean
ecogScore.between Array<>
ecogScore.equal integer
ecogScore.exists boolean
ecogScore.greaterThan integer
ecogScore.greaterThanOrEqual integer
ecogScore.lessThan integer
ecogScore.lessThanOrEqual integer
ecogScore.not.between Array<>
ecogScore.not.equal integer
ecogScore.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
karnofskyInterpretation string
karnofskyInterpretation.anyOf Array<string>
karnofskyInterpretation.descendantsOf string
karnofskyInterpretation.exists boolean
karnofskyInterpretation.not string
karnofskyInterpretation.not.anyOf Array<string>
karnofskyInterpretation.not.exists boolean
karnofskyScore.between Array<>
karnofskyScore.equal integer
karnofskyScore.exists boolean
karnofskyScore.greaterThan integer
karnofskyScore.greaterThanOrEqual integer
karnofskyScore.lessThan integer
karnofskyScore.lessThanOrEqual integer
karnofskyScore.not.between Array<>
karnofskyScore.not.equal integer
karnofskyScore.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

PerformanceStatusPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
ecogInterpretation
ecogScore integer
externalSource string
externalSourceId string
id string(uuid)
karnofskyInterpretation
karnofskyScore integer
updatedAt string(date-time)
updatedBy Array<string>

Period

Name Type
end string(date)
start string(date)

Project

Name Type
clinicalCenters Array<string>
createdAt string(date-time)
createdBy string
dataConstraints
description string
ethicsApprovalNumber string
externalSource string
externalSourceId string
id string(uuid)
leader string
members Array<string>
status
summary string
title string
updatedAt string(date-time)
updatedBy Array<string>

ProjectCreate

Name Type
clinicalCenters Array<string>
dataConstraints
ethicsApprovalNumber string
externalSource string
externalSourceId string
leader string
members Array<string>
status
summary string
title string

ProjectDataManagerGrant

Name Type
createdAt string(date-time)
createdBy string
description string
externalSource string
externalSourceId string
id string(uuid)
isValid boolean
member string
projectId string(uuid)
revoked boolean
updatedAt string(date-time)
updatedBy Array<string>
validityPeriod Period

ProjectDataManagerGrantCreate

Name Type
externalSource string
externalSourceId string
revoked boolean
validityPeriod Period

ProjectFilters

Name Type
clinicalCenters string
clinicalCenters.anyOf Array<string>
clinicalCenters.beginsWith string
clinicalCenters.contains string
clinicalCenters.endsWith string
clinicalCenters.not string
clinicalCenters.not.anyOf Array<string>
clinicalCenters.not.beginsWith string
clinicalCenters.not.contains string
clinicalCenters.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
dataConstraints.exists boolean
dataConstraints.not.exists boolean
ethicsApprovalNumber string
ethicsApprovalNumber.anyOf Array<string>
ethicsApprovalNumber.beginsWith string
ethicsApprovalNumber.contains string
ethicsApprovalNumber.endsWith string
ethicsApprovalNumber.not string
ethicsApprovalNumber.not.anyOf Array<string>
ethicsApprovalNumber.not.beginsWith string
ethicsApprovalNumber.not.contains string
ethicsApprovalNumber.not.endsWith string
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
leader.username string
leader.username.anyOf Array<string>
leader.username.not string
leader.username.not.anyOf string
members.exists boolean
members.not.exists boolean
members.username string
members.username.anyOf Array<string>
members.username.not string
members.username.not.anyOf string
status
status.anyOf Array<string>
status.exists boolean
status.not
status.not.exists boolean
summary string
summary.anyOf Array<string>
summary.beginsWith string
summary.contains string
summary.endsWith string
summary.not string
summary.not.anyOf Array<string>
summary.not.beginsWith string
summary.not.contains string
summary.not.endsWith string
title string
title.anyOf Array<string>
title.beginsWith string
title.contains string
title.endsWith string
title.not string
title.not.anyOf Array<string>
title.not.beginsWith string
title.not.contains string
title.not.endsWith string
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

ProjectStatusChoices

Type: string

ProteinChangeType

Type: string

Radiotherapy

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
description string
dosages Array<RadiotherapyDosage>
duration Measure
externalSource string
externalSourceId string
id string(uuid)
intent RadiotherapyIntentChoices
period Period
sessions integer
settings Array<RadiotherapySetting>
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

RadiotherapyCreate

Name Type
caseId string(uuid)
externalSource string
externalSourceId string
intent RadiotherapyIntentChoices
period Period
sessions integer
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)

RadiotherapyDosage

Name Type
createdAt string(date-time)
createdBy string
description string
dose
externalSource string
externalSourceId string
fractions integer
id string(uuid)
irradiatedVolume CodedConcept
irradiatedVolumeMorphology
irradiatedVolumeQualifier
updatedAt string(date-time)
updatedBy Array<string>

RadiotherapyDosageCreate

Name Type
dose
externalSource string
externalSourceId string
fractions integer
irradiatedVolume CodedConcept
irradiatedVolumeMorphology
irradiatedVolumeQualifier

RadiotherapyDosagePartial

Name Type
anonymized boolean
createdAt string(date-time)
createdBy string
dose
externalSource string
externalSourceId string
fractions integer
id string(uuid)
irradiatedVolume
irradiatedVolumeMorphology
irradiatedVolumeQualifier
updatedAt string(date-time)
updatedBy Array<string>

RadiotherapyFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
dosages.createdAt.after string(date)
dosages.createdAt.before string(date)
dosages.createdAt.between Array<>
dosages.createdAt.exists boolean
dosages.createdAt.not.between Array<>
dosages.createdAt.not.exists boolean
dosages.createdAt.not.on string(date)
dosages.createdAt.on string(date)
dosages.createdAt.onOrAfter string(date)
dosages.createdAt.onOrBefore string(date)
dosages.dose.between Array<>
dosages.dose.equal number
dosages.dose.exists boolean
dosages.dose.greaterThan number
dosages.dose.greaterThanOrEqual number
dosages.dose.lessThan number
dosages.dose.lessThanOrEqual number
dosages.dose.not.between Array<>
dosages.dose.not.equal number
dosages.dose.not.exists boolean
dosages.externalSource string
dosages.externalSource.anyOf Array<string>
dosages.externalSource.beginsWith string
dosages.externalSource.contains string
dosages.externalSource.endsWith string
dosages.externalSource.exists boolean
dosages.externalSource.not string
dosages.externalSource.not.anyOf Array<string>
dosages.externalSource.not.beginsWith string
dosages.externalSource.not.contains string
dosages.externalSource.not.endsWith string
dosages.externalSource.not.exists boolean
dosages.fractions.between Array<>
dosages.fractions.equal integer
dosages.fractions.exists boolean
dosages.fractions.greaterThan integer
dosages.fractions.greaterThanOrEqual integer
dosages.fractions.lessThan integer
dosages.fractions.lessThanOrEqual integer
dosages.fractions.not.between Array<>
dosages.fractions.not.equal integer
dosages.fractions.not.exists boolean
dosages.id string
dosages.id.anyOf Array<string>
dosages.id.beginsWith string
dosages.id.contains string
dosages.id.endsWith string
dosages.id.not string
dosages.id.not.anyOf Array<string>
dosages.id.not.beginsWith string
dosages.id.not.contains string
dosages.id.not.endsWith string
dosages.irradiatedVolume string
dosages.irradiatedVolume.anyOf Array<string>
dosages.irradiatedVolume.descendantsOf string
dosages.irradiatedVolume.not string
dosages.irradiatedVolume.not.anyOf Array<string>
dosages.irradiatedVolumeMorphology string
dosages.irradiatedVolumeMorphology.anyOf Array<string>
dosages.irradiatedVolumeMorphology.descendantsOf string
dosages.irradiatedVolumeMorphology.exists boolean
dosages.irradiatedVolumeMorphology.not string
dosages.irradiatedVolumeMorphology.not.anyOf Array<string>
dosages.irradiatedVolumeMorphology.not.exists boolean
dosages.irradiatedVolumeQualifier string
dosages.irradiatedVolumeQualifier.anyOf Array<string>
dosages.irradiatedVolumeQualifier.descendantsOf string
dosages.irradiatedVolumeQualifier.exists boolean
dosages.irradiatedVolumeQualifier.not string
dosages.irradiatedVolumeQualifier.not.anyOf Array<string>
dosages.irradiatedVolumeQualifier.not.exists boolean
dosages.updatedAt.after string(date)
dosages.updatedAt.before string(date)
dosages.updatedAt.between Array<>
dosages.updatedAt.exists boolean
dosages.updatedAt.not.between Array<>
dosages.updatedAt.not.exists boolean
dosages.updatedAt.not.on string(date)
dosages.updatedAt.on string(date)
dosages.updatedAt.onOrAfter string(date)
dosages.updatedAt.onOrBefore string(date)
duration.between Array<>
duration.equal number
duration.greaterThan number
duration.greaterThanOrEqual number
duration.lessThan number
duration.lessThanOrEqual number
duration.not.between Array<>
duration.not.equal number
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
intent
intent.anyOf Array<string>
intent.not
period.containedBy Array<>
period.contains Array<>
period.not.containedBy Array<>
period.not.contains Array<>
period.not.overlaps Array<>
period.overlaps Array<>
sessions.between Array<>
sessions.equal integer
sessions.greaterThan integer
sessions.greaterThanOrEqual integer
sessions.lessThan integer
sessions.lessThanOrEqual integer
sessions.not.between Array<>
sessions.not.equal integer
settings.createdAt.after string(date)
settings.createdAt.before string(date)
settings.createdAt.between Array<>
settings.createdAt.exists boolean
settings.createdAt.not.between Array<>
settings.createdAt.not.exists boolean
settings.createdAt.not.on string(date)
settings.createdAt.on string(date)
settings.createdAt.onOrAfter string(date)
settings.createdAt.onOrBefore string(date)
settings.externalSource string
settings.externalSource.anyOf Array<string>
settings.externalSource.beginsWith string
settings.externalSource.contains string
settings.externalSource.endsWith string
settings.externalSource.exists boolean
settings.externalSource.not string
settings.externalSource.not.anyOf Array<string>
settings.externalSource.not.beginsWith string
settings.externalSource.not.contains string
settings.externalSource.not.endsWith string
settings.externalSource.not.exists boolean
settings.id string
settings.id.anyOf Array<string>
settings.id.beginsWith string
settings.id.contains string
settings.id.endsWith string
settings.id.not string
settings.id.not.anyOf Array<string>
settings.id.not.beginsWith string
settings.id.not.contains string
settings.id.not.endsWith string
settings.modality string
settings.modality.anyOf Array<string>
settings.modality.descendantsOf string
settings.modality.not string
settings.modality.not.anyOf Array<string>
settings.technique string
settings.technique.anyOf Array<string>
settings.technique.descendantsOf string
settings.technique.not string
settings.technique.not.anyOf Array<string>
settings.updatedAt.after string(date)
settings.updatedAt.before string(date)
settings.updatedAt.between Array<>
settings.updatedAt.exists boolean
settings.updatedAt.not.between Array<>
settings.updatedAt.not.exists boolean
settings.updatedAt.not.on string(date)
settings.updatedAt.on string(date)
settings.updatedAt.onOrAfter string(date)
settings.updatedAt.onOrBefore string(date)
targetedEntitiesIds string
targetedEntitiesIds.anyOf Array<string>
targetedEntitiesIds.beginsWith string
targetedEntitiesIds.contains string
targetedEntitiesIds.endsWith string
targetedEntitiesIds.exists boolean
targetedEntitiesIds.not string
targetedEntitiesIds.not.anyOf Array<string>
targetedEntitiesIds.not.beginsWith string
targetedEntitiesIds.not.contains string
targetedEntitiesIds.not.endsWith string
targetedEntitiesIds.not.exists boolean
terminationReason string
terminationReason.anyOf Array<string>
terminationReason.descendantsOf string
terminationReason.exists boolean
terminationReason.not string
terminationReason.not.anyOf Array<string>
terminationReason.not.exists boolean
therapyLineId string
therapyLineId.anyOf Array<string>
therapyLineId.beginsWith string
therapyLineId.contains string
therapyLineId.endsWith string
therapyLineId.exists boolean
therapyLineId.not string
therapyLineId.not.anyOf Array<string>
therapyLineId.not.beginsWith string
therapyLineId.not.contains string
therapyLineId.not.endsWith string
therapyLineId.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

RadiotherapyIntentChoices

Type: string

RadiotherapyPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
dosages Array<RadiotherapyDosagePartial>
duration
externalSource string
externalSourceId string
id string(uuid)
intent
period string
sessions integer
settings Array<RadiotherapySettingPartial>
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

RadiotherapySetting

Name Type
createdAt string(date-time)
createdBy string
description string
externalSource string
externalSourceId string
id string(uuid)
modality CodedConcept
technique CodedConcept
updatedAt string(date-time)
updatedBy Array<string>

RadiotherapySettingCreate

Name Type
externalSource string
externalSourceId string
modality CodedConcept
technique CodedConcept

RadiotherapySettingPartial

Name Type
anonymized boolean
createdAt string(date-time)
createdBy string
externalSource string
externalSourceId string
id string(uuid)
modality
technique
updatedAt string(date-time)
updatedBy Array<string>

RaiStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
methodology
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

RaiStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
methodology
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

RaiStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
methodology
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

Range

Name Type
end
start

RhabdomyosarcomaClinicalGroup

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

RhabdomyosarcomaClinicalGroupCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

RhabdomyosarcomaClinicalGroupPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

RiskAssessment

Name Type
anonymized boolean
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
methodology CodedConcept
risk CodedConcept
score number
updatedAt string(date-time)
updatedBy Array<string>

RiskAssessmentCreate

Name Type
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
methodology CodedConcept
risk CodedConcept
score number

RiskAssessmentFilters

Name Type
assessedEntitiesIds string
assessedEntitiesIds.anyOf Array<string>
assessedEntitiesIds.beginsWith string
assessedEntitiesIds.contains string
assessedEntitiesIds.endsWith string
assessedEntitiesIds.exists boolean
assessedEntitiesIds.not string
assessedEntitiesIds.not.anyOf Array<string>
assessedEntitiesIds.not.beginsWith string
assessedEntitiesIds.not.contains string
assessedEntitiesIds.not.endsWith string
assessedEntitiesIds.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
methodology string
methodology.anyOf Array<string>
methodology.descendantsOf string
methodology.not string
methodology.not.anyOf Array<string>
risk string
risk.anyOf Array<string>
risk.descendantsOf string
risk.not string
risk.not.anyOf Array<string>
score.between Array<>
score.equal number
score.exists boolean
score.greaterThan number
score.greaterThanOrEqual number
score.lessThan number
score.lessThanOrEqual number
score.not.between Array<>
score.not.equal number
score.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

RiskAssessmentPartial

Name Type
anonymized boolean
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
methodology
risk
score number
updatedAt string(date-time)
updatedBy Array<string>

RISSStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

RISSStagingCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

RISSStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

RNAChangeType

Type: string

RulesetCondition

Type: string

StagingDomain

Type: string

StagingFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
stage string
stage.anyOf Array<string>
stage.descendantsOf string
stage.not string
stage.not.anyOf Array<string>
stagedEntitiesIds string
stagedEntitiesIds.anyOf Array<string>
stagedEntitiesIds.beginsWith string
stagedEntitiesIds.contains string
stagedEntitiesIds.endsWith string
stagedEntitiesIds.exists boolean
stagedEntitiesIds.not string
stagedEntitiesIds.not.anyOf Array<string>
stagedEntitiesIds.not.beginsWith string
stagedEntitiesIds.not.contains string
stagedEntitiesIds.not.endsWith string
stagedEntitiesIds.not.exists boolean
stagingDomain
stagingDomain.anyOf Array<string>
stagingDomain.not
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

Surgery

Name Type
anonymized boolean
bodysite
bodysiteLaterality
bodysiteQualifier
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
intent SurgeryIntentChoices
outcome
procedure CodedConcept
targetedEntitiesIds Array<string(uuid)>
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

SurgeryCreate

Name Type
bodysite
bodysiteLaterality
bodysiteQualifier
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
intent SurgeryIntentChoices
outcome
procedure CodedConcept
targetedEntitiesIds Array<string(uuid)>
therapyLineId string(uuid)

SurgeryFilters

Name Type
bodysite string
bodysite.anyOf Array<string>
bodysite.descendantsOf string
bodysite.exists boolean
bodysite.not string
bodysite.not.anyOf Array<string>
bodysite.not.exists boolean
bodysiteLaterality string
bodysiteLaterality.anyOf Array<string>
bodysiteLaterality.descendantsOf string
bodysiteLaterality.exists boolean
bodysiteLaterality.not string
bodysiteLaterality.not.anyOf Array<string>
bodysiteLaterality.not.exists boolean
bodysiteQualifier string
bodysiteQualifier.anyOf Array<string>
bodysiteQualifier.descendantsOf string
bodysiteQualifier.exists boolean
bodysiteQualifier.not string
bodysiteQualifier.not.anyOf Array<string>
bodysiteQualifier.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
intent
intent.anyOf Array<string>
intent.not
outcome string
outcome.anyOf Array<string>
outcome.descendantsOf string
outcome.exists boolean
outcome.not string
outcome.not.anyOf Array<string>
outcome.not.exists boolean
procedure string
procedure.anyOf Array<string>
procedure.descendantsOf string
procedure.not string
procedure.not.anyOf Array<string>
targetedEntitiesIds string
targetedEntitiesIds.anyOf Array<string>
targetedEntitiesIds.beginsWith string
targetedEntitiesIds.contains string
targetedEntitiesIds.endsWith string
targetedEntitiesIds.exists boolean
targetedEntitiesIds.not string
targetedEntitiesIds.not.anyOf Array<string>
targetedEntitiesIds.not.beginsWith string
targetedEntitiesIds.not.contains string
targetedEntitiesIds.not.endsWith string
targetedEntitiesIds.not.exists boolean
therapyLineId string
therapyLineId.anyOf Array<string>
therapyLineId.beginsWith string
therapyLineId.contains string
therapyLineId.endsWith string
therapyLineId.exists boolean
therapyLineId.not string
therapyLineId.not.anyOf Array<string>
therapyLineId.not.beginsWith string
therapyLineId.not.contains string
therapyLineId.not.endsWith string
therapyLineId.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

SurgeryIntentChoices

Type: string

SurgeryPartial

Name Type
anonymized boolean
bodysite
bodysiteLaterality
bodysiteQualifier
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
intent
outcome
procedure
targetedEntitiesIds Array<string(uuid)>
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

SystemicTherapy

Name Type
adjunctiveRole
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
cycles integer
description string
duration Measure
externalSource string
externalSourceId string
id string(uuid)
intent SystemicTherapyIntentChoices
isAdjunctive boolean
medications Array<SystemicTherapyMedication>
period Period
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

SystemicTherapyCreate

Name Type
adjunctiveRole
caseId string(uuid)
cycles integer
externalSource string
externalSourceId string
intent SystemicTherapyIntentChoices
period Period
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)

SystemicTherapyFilters

Name Type
adjunctiveRole string
adjunctiveRole.anyOf Array<string>
adjunctiveRole.descendantsOf string
adjunctiveRole.exists boolean
adjunctiveRole.not string
adjunctiveRole.not.anyOf Array<string>
adjunctiveRole.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
cycles.between Array<>
cycles.equal integer
cycles.exists boolean
cycles.greaterThan integer
cycles.greaterThanOrEqual integer
cycles.lessThan integer
cycles.lessThanOrEqual integer
cycles.not.between Array<>
cycles.not.equal integer
cycles.not.exists boolean
duration.between Array<>
duration.equal number
duration.greaterThan number
duration.greaterThanOrEqual number
duration.lessThan number
duration.lessThanOrEqual number
duration.not.between Array<>
duration.not.equal number
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
intent
intent.anyOf Array<string>
intent.not
isAdjunctive boolean
medications.createdAt.after string(date)
medications.createdAt.before string(date)
medications.createdAt.between Array<>
medications.createdAt.exists boolean
medications.createdAt.not.between Array<>
medications.createdAt.not.exists boolean
medications.createdAt.not.on string(date)
medications.createdAt.on string(date)
medications.createdAt.onOrAfter string(date)
medications.createdAt.onOrBefore string(date)
medications.dosageMass.between Array<>
medications.dosageMass.equal number
medications.dosageMass.exists boolean
medications.dosageMass.greaterThan number
medications.dosageMass.greaterThanOrEqual number
medications.dosageMass.lessThan number
medications.dosageMass.lessThanOrEqual number
medications.dosageMass.not.between Array<>
medications.dosageMass.not.equal number
medications.dosageMass.not.exists boolean
medications.dosageMassConcentration.between Array<>
medications.dosageMassConcentration.equal number
medications.dosageMassConcentration.exists boolean
medications.dosageMassConcentration.greaterThan number
medications.dosageMassConcentration.greaterThanOrEqual number
medications.dosageMassConcentration.lessThan number
medications.dosageMassConcentration.lessThanOrEqual number
medications.dosageMassConcentration.not.between Array<>
medications.dosageMassConcentration.not.equal number
medications.dosageMassConcentration.not.exists boolean
medications.dosageMassSurface.between Array<>
medications.dosageMassSurface.equal number
medications.dosageMassSurface.exists boolean
medications.dosageMassSurface.greaterThan number
medications.dosageMassSurface.greaterThanOrEqual number
medications.dosageMassSurface.lessThan number
medications.dosageMassSurface.lessThanOrEqual number
medications.dosageMassSurface.not.between Array<>
medications.dosageMassSurface.not.equal number
medications.dosageMassSurface.not.exists boolean
medications.dosageRateMass.between Array<>
medications.dosageRateMass.equal number
medications.dosageRateMass.exists boolean
medications.dosageRateMass.greaterThan number
medications.dosageRateMass.greaterThanOrEqual number
medications.dosageRateMass.lessThan number
medications.dosageRateMass.lessThanOrEqual number
medications.dosageRateMass.not.between Array<>
medications.dosageRateMass.not.equal number
medications.dosageRateMass.not.exists boolean
medications.dosageRateMassConcentration.between Array<>
medications.dosageRateMassConcentration.equal number
medications.dosageRateMassConcentration.exists boolean
medications.dosageRateMassConcentration.greaterThan number
medications.dosageRateMassConcentration.greaterThanOrEqual number
medications.dosageRateMassConcentration.lessThan number
medications.dosageRateMassConcentration.lessThanOrEqual number
medications.dosageRateMassConcentration.not.between Array<>
medications.dosageRateMassConcentration.not.equal number
medications.dosageRateMassConcentration.not.exists boolean
medications.dosageRateMassSurface.between Array<>
medications.dosageRateMassSurface.equal number
medications.dosageRateMassSurface.exists boolean
medications.dosageRateMassSurface.greaterThan number
medications.dosageRateMassSurface.greaterThanOrEqual number
medications.dosageRateMassSurface.lessThan number
medications.dosageRateMassSurface.lessThanOrEqual number
medications.dosageRateMassSurface.not.between Array<>
medications.dosageRateMassSurface.not.equal number
medications.dosageRateMassSurface.not.exists boolean
medications.dosageRateVolume.between Array<>
medications.dosageRateVolume.equal number
medications.dosageRateVolume.exists boolean
medications.dosageRateVolume.greaterThan number
medications.dosageRateVolume.greaterThanOrEqual number
medications.dosageRateVolume.lessThan number
medications.dosageRateVolume.lessThanOrEqual number
medications.dosageRateVolume.not.between Array<>
medications.dosageRateVolume.not.equal number
medications.dosageRateVolume.not.exists boolean
medications.dosageVolume.between Array<>
medications.dosageVolume.equal number
medications.dosageVolume.exists boolean
medications.dosageVolume.greaterThan number
medications.dosageVolume.greaterThanOrEqual number
medications.dosageVolume.lessThan number
medications.dosageVolume.lessThanOrEqual number
medications.dosageVolume.not.between Array<>
medications.dosageVolume.not.equal number
medications.dosageVolume.not.exists boolean
medications.drug string
medications.drug.anyOf Array<string>
medications.drug.descendantsOf string
medications.drug.not string
medications.drug.not.anyOf Array<string>
medications.externalSource string
medications.externalSource.anyOf Array<string>
medications.externalSource.beginsWith string
medications.externalSource.contains string
medications.externalSource.endsWith string
medications.externalSource.exists boolean
medications.externalSource.not string
medications.externalSource.not.anyOf Array<string>
medications.externalSource.not.beginsWith string
medications.externalSource.not.contains string
medications.externalSource.not.endsWith string
medications.externalSource.not.exists boolean
medications.id string
medications.id.anyOf Array<string>
medications.id.beginsWith string
medications.id.contains string
medications.id.endsWith string
medications.id.not string
medications.id.not.anyOf Array<string>
medications.id.not.beginsWith string
medications.id.not.contains string
medications.id.not.endsWith string
medications.route string
medications.route.anyOf Array<string>
medications.route.descendantsOf string
medications.route.exists boolean
medications.route.not string
medications.route.not.anyOf Array<string>
medications.route.not.exists boolean
medications.updatedAt.after string(date)
medications.updatedAt.before string(date)
medications.updatedAt.between Array<>
medications.updatedAt.exists boolean
medications.updatedAt.not.between Array<>
medications.updatedAt.not.exists boolean
medications.updatedAt.not.on string(date)
medications.updatedAt.on string(date)
medications.updatedAt.onOrAfter string(date)
medications.updatedAt.onOrBefore string(date)
medications.usedOfflabel boolean
medications.usedOfflabel.exists boolean
medications.usedOfflabel.not.exists boolean
medications.withinSoc boolean
medications.withinSoc.exists boolean
medications.withinSoc.not.exists boolean
period.containedBy Array<>
period.contains Array<>
period.not.containedBy Array<>
period.not.contains Array<>
period.not.overlaps Array<>
period.overlaps Array<>
targetedEntitiesIds string
targetedEntitiesIds.anyOf Array<string>
targetedEntitiesIds.beginsWith string
targetedEntitiesIds.contains string
targetedEntitiesIds.endsWith string
targetedEntitiesIds.exists boolean
targetedEntitiesIds.not string
targetedEntitiesIds.not.anyOf Array<string>
targetedEntitiesIds.not.beginsWith string
targetedEntitiesIds.not.contains string
targetedEntitiesIds.not.endsWith string
targetedEntitiesIds.not.exists boolean
terminationReason string
terminationReason.anyOf Array<string>
terminationReason.descendantsOf string
terminationReason.exists boolean
terminationReason.not string
terminationReason.not.anyOf Array<string>
terminationReason.not.exists boolean
therapyLineId string
therapyLineId.anyOf Array<string>
therapyLineId.beginsWith string
therapyLineId.contains string
therapyLineId.endsWith string
therapyLineId.exists boolean
therapyLineId.not string
therapyLineId.not.anyOf Array<string>
therapyLineId.not.beginsWith string
therapyLineId.not.contains string
therapyLineId.not.endsWith string
therapyLineId.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

SystemicTherapyIntentChoices

Type: string

SystemicTherapyMedication

Name Type
createdAt string(date-time)
createdBy string
description string
dosageMass
dosageMassConcentration
dosageMassSurface
dosageRateMass
dosageRateMassConcentration
dosageRateMassSurface
dosageRateVolume
dosageVolume
drug CodedConcept
externalSource string
externalSourceId string
id string(uuid)
route
updatedAt string(date-time)
updatedBy Array<string>
usedOfflabel boolean
withinSoc boolean

SystemicTherapyMedicationCreate

Name Type
dosageMass
dosageMassConcentration
dosageMassSurface
dosageRateMass
dosageRateMassConcentration
dosageRateMassSurface
dosageRateVolume
dosageVolume
drug CodedConcept
externalSource string
externalSourceId string
route
usedOfflabel boolean
withinSoc boolean

SystemicTherapyMedicationPartial

Name Type
anonymized boolean
createdAt string(date-time)
createdBy string
dosageMass
dosageMassConcentration
dosageMassSurface
dosageRateMass
dosageRateMassConcentration
dosageRateMassSurface
dosageRateVolume
dosageVolume
drug
externalSource string
externalSourceId string
id string(uuid)
route
updatedAt string(date-time)
updatedBy Array<string>
usedOfflabel boolean
withinSoc boolean

SystemicTherapyPartial

Name Type
adjunctiveRole
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
cycles integer
duration
externalSource string
externalSourceId string
id string(uuid)
intent
isAdjunctive boolean
medications Array<SystemicTherapyMedicationPartial>
period string
targetedEntitiesIds Array<string(uuid)>
terminationReason
therapyLineId string(uuid)
updatedAt string(date-time)
updatedBy Array<string>

TerminologyFilters

Name Type
codes
query

TherapyLine

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
description string
externalSource string
externalSourceId string
id string(uuid)
intent TherapyLineIntentChoices
label string
ordinal integer
period
progressionDate string(date)
progressionFreeSurvival number
updatedAt string(date-time)
updatedBy Array<string>

TherapyLineCreate

Name Type
caseId string(uuid)
externalSource string
externalSourceId string
intent TherapyLineIntentChoices
ordinal integer
progressionDate string(date)

TherapyLineFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
intent
intent.anyOf Array<string>
intent.not
label string
label.anyOf Array<string>
label.beginsWith string
label.contains string
label.endsWith string
label.not string
label.not.anyOf Array<string>
label.not.beginsWith string
label.not.contains string
label.not.endsWith string
ordinal.between Array<>
ordinal.equal integer
ordinal.greaterThan integer
ordinal.greaterThanOrEqual integer
ordinal.lessThan integer
ordinal.lessThanOrEqual integer
ordinal.not.between Array<>
ordinal.not.equal integer
period.containedBy Array<>
period.contains Array<>
period.exists boolean
period.not.containedBy Array<>
period.not.contains Array<>
period.not.exists boolean
period.not.overlaps Array<>
period.overlaps Array<>
progressionDate.after string(date)
progressionDate.before string(date)
progressionDate.between Array<>
progressionDate.exists boolean
progressionDate.not.between Array<>
progressionDate.not.exists boolean
progressionDate.not.on string(date)
progressionDate.on string(date)
progressionDate.onOrAfter string(date)
progressionDate.onOrBefore string(date)
progressionFreeSurvival.between Array<>
progressionFreeSurvival.equal number
progressionFreeSurvival.exists boolean
progressionFreeSurvival.greaterThan number
progressionFreeSurvival.greaterThanOrEqual number
progressionFreeSurvival.lessThan number
progressionFreeSurvival.lessThanOrEqual number
progressionFreeSurvival.not.between Array<>
progressionFreeSurvival.not.equal number
progressionFreeSurvival.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

TherapyLineIntentChoices

Type: string

TherapyLinePartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
externalSource string
externalSourceId string
id string(uuid)
intent
label string
ordinal integer
period string
progressionDate string(date)
progressionFreeSurvival number
updatedAt string(date-time)
updatedBy Array<string>

TNMStaging

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
distantmetastases
externalSource string
externalSourceId string
grade
id string(uuid)
lymphaticinvasion
methodology
pathological boolean
perineuralinvasion
primarytumor
regionalnodes
residualtumor
serumtumormarkerlevel
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>
venousinvasion

TNMStagingCreate

Name Type
caseId string(uuid)
date string(date)
distantmetastases
externalSource string
externalSourceId string
grade
lymphaticinvasion
methodology
pathological boolean
perineuralinvasion
primarytumor
regionalnodes
residualtumor
serumtumormarkerlevel
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
venousinvasion

TNMStagingPartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
distantmetastases
externalSource string
externalSourceId string
grade
id string(uuid)
lymphaticinvasion
methodology
pathological boolean
perineuralinvasion
primarytumor
regionalnodes
residualtumor
serumtumormarkerlevel
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>
venousinvasion

TreatmentResponse

Name Type
anonymized boolean
assessedBodysites Array<CodedConcept>
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
methodology CodedConcept
recist CodedConcept
recistInterpreted boolean
updatedAt string(date-time)
updatedBy Array<string>

TreatmentResponseCreate

Name Type
assessedBodysites Array<CodedConcept>
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
methodology CodedConcept
recist CodedConcept
recistInterpreted boolean

TreatmentResponseFilters

Name Type
assessedBodysites string
assessedBodysites.allOf Array<string>
assessedBodysites.anyOf Array<string>
assessedBodysites.descendantsOf string
assessedBodysites.exists boolean
assessedBodysites.not string
assessedBodysites.not.allOf Array<string>
assessedBodysites.not.anyOf Array<string>
assessedBodysites.not.exists boolean
assessedEntitiesIds string
assessedEntitiesIds.anyOf Array<string>
assessedEntitiesIds.beginsWith string
assessedEntitiesIds.contains string
assessedEntitiesIds.endsWith string
assessedEntitiesIds.exists boolean
assessedEntitiesIds.not string
assessedEntitiesIds.not.anyOf Array<string>
assessedEntitiesIds.not.beginsWith string
assessedEntitiesIds.not.contains string
assessedEntitiesIds.not.endsWith string
assessedEntitiesIds.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
methodology string
methodology.anyOf Array<string>
methodology.descendantsOf string
methodology.not string
methodology.not.anyOf Array<string>
recist string
recist.anyOf Array<string>
recist.descendantsOf string
recist.not string
recist.not.anyOf Array<string>
recistInterpreted boolean
recistInterpreted.exists boolean
recistInterpreted.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

TreatmentResponsePartial

Name Type
anonymized boolean
assessedBodysites
assessedEntitiesIds Array<string(uuid)>
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
methodology
recist
recistInterpreted boolean
updatedAt string(date-time)
updatedBy Array<string>

TumorBoardFilters

Name Type
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
recommendations string
recommendations.allOf Array<string>
recommendations.anyOf Array<string>
recommendations.descendantsOf string
recommendations.exists boolean
recommendations.not string
recommendations.not.allOf Array<string>
recommendations.not.anyOf Array<string>
recommendations.not.exists boolean
relatedEntitiesIds string
relatedEntitiesIds.anyOf Array<string>
relatedEntitiesIds.beginsWith string
relatedEntitiesIds.contains string
relatedEntitiesIds.endsWith string
relatedEntitiesIds.exists boolean
relatedEntitiesIds.not string
relatedEntitiesIds.not.anyOf Array<string>
relatedEntitiesIds.not.beginsWith string
relatedEntitiesIds.not.contains string
relatedEntitiesIds.not.endsWith string
relatedEntitiesIds.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

TumorMarker

Name Type
analyte CodedConcept
anonymized boolean
arbitraryConcentration
caseId string(uuid)
combinedPositiveScore
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
fraction
id string(uuid)
immuneCellScore
immunohistochemicalScore
massConcentration
multipleOfMedian
nuclearExpressionStatus
presence
relatedEntitiesIds Array<string(uuid)>
substanceConcentration
tumorProportionScore
updatedAt string(date-time)
updatedBy Array<string>

TumorMarkerCreate

Name Type
analyte CodedConcept
arbitraryConcentration
caseId string(uuid)
combinedPositiveScore
date string(date)
externalSource string
externalSourceId string
fraction
immuneCellScore
immunohistochemicalScore
massConcentration
multipleOfMedian
nuclearExpressionStatus
presence
relatedEntitiesIds Array<string(uuid)>
substanceConcentration
tumorProportionScore

TumorMarkerFilters

Name Type
analyte string
analyte.anyOf Array<string>
analyte.descendantsOf string
analyte.not string
analyte.not.anyOf Array<string>
arbitraryConcentration.between Array<>
arbitraryConcentration.equal number
arbitraryConcentration.exists boolean
arbitraryConcentration.greaterThan number
arbitraryConcentration.greaterThanOrEqual number
arbitraryConcentration.lessThan number
arbitraryConcentration.lessThanOrEqual number
arbitraryConcentration.not.between Array<>
arbitraryConcentration.not.equal number
arbitraryConcentration.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
combinedPositiveScore.between Array<>
combinedPositiveScore.equal number
combinedPositiveScore.exists boolean
combinedPositiveScore.greaterThan number
combinedPositiveScore.greaterThanOrEqual number
combinedPositiveScore.lessThan number
combinedPositiveScore.lessThanOrEqual number
combinedPositiveScore.not.between Array<>
combinedPositiveScore.not.equal number
combinedPositiveScore.not.exists boolean
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
fraction.between Array<>
fraction.equal number
fraction.exists boolean
fraction.greaterThan number
fraction.greaterThanOrEqual number
fraction.lessThan number
fraction.lessThanOrEqual number
fraction.not.between Array<>
fraction.not.equal number
fraction.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
immuneCellScore
immuneCellScore.anyOf Array<string>
immuneCellScore.exists boolean
immuneCellScore.not
immuneCellScore.not.exists boolean
immunohistochemicalScore
immunohistochemicalScore.anyOf Array<string>
immunohistochemicalScore.exists boolean
immunohistochemicalScore.not
immunohistochemicalScore.not.exists boolean
massConcentration.between Array<>
massConcentration.equal number
massConcentration.exists boolean
massConcentration.greaterThan number
massConcentration.greaterThanOrEqual number
massConcentration.lessThan number
massConcentration.lessThanOrEqual number
massConcentration.not.between Array<>
massConcentration.not.equal number
massConcentration.not.exists boolean
multipleOfMedian.between Array<>
multipleOfMedian.equal number
multipleOfMedian.exists boolean
multipleOfMedian.greaterThan number
multipleOfMedian.greaterThanOrEqual number
multipleOfMedian.lessThan number
multipleOfMedian.lessThanOrEqual number
multipleOfMedian.not.between Array<>
multipleOfMedian.not.equal number
multipleOfMedian.not.exists boolean
nuclearExpressionStatus
nuclearExpressionStatus.anyOf Array<string>
nuclearExpressionStatus.exists boolean
nuclearExpressionStatus.not
nuclearExpressionStatus.not.exists boolean
presence
presence.anyOf Array<string>
presence.exists boolean
presence.not
presence.not.exists boolean
relatedEntitiesIds string
relatedEntitiesIds.anyOf Array<string>
relatedEntitiesIds.beginsWith string
relatedEntitiesIds.contains string
relatedEntitiesIds.endsWith string
relatedEntitiesIds.exists boolean
relatedEntitiesIds.not string
relatedEntitiesIds.not.anyOf Array<string>
relatedEntitiesIds.not.beginsWith string
relatedEntitiesIds.not.contains string
relatedEntitiesIds.not.endsWith string
relatedEntitiesIds.not.exists boolean
substanceConcentration.between Array<>
substanceConcentration.equal number
substanceConcentration.exists boolean
substanceConcentration.greaterThan number
substanceConcentration.greaterThanOrEqual number
substanceConcentration.lessThan number
substanceConcentration.lessThanOrEqual number
substanceConcentration.not.between Array<>
substanceConcentration.not.equal number
substanceConcentration.not.exists boolean
tumorProportionScore
tumorProportionScore.anyOf Array<string>
tumorProportionScore.exists boolean
tumorProportionScore.not
tumorProportionScore.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)

TumorMarkerImmuneCellScoreChoices

Type: string

TumorMarkerImmunohistochemicalScoreChoices

Type: string

TumorMarkerNuclearExpressionStatusChoices

Type: string

TumorMarkerPartial

Name Type
analyte
anonymized boolean
arbitraryConcentration
caseId string(uuid)
combinedPositiveScore
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
fraction
id string(uuid)
immuneCellScore
immunohistochemicalScore
massConcentration
multipleOfMedian
nuclearExpressionStatus
presence
relatedEntitiesIds Array<string(uuid)>
substanceConcentration
tumorProportionScore
updatedAt string(date-time)
updatedBy Array<string>

TumorMarkerPresenceChoices

Type: string

TumorMarkerTumorProportionScoreChoices

Type: string

TumorMutationalBurden

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
status
updatedAt string(date-time)
updatedBy Array<string>
value number

TumorMutationalBurdenCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
status
value number

TumorMutationalBurdenPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
status
updatedAt string(date-time)
updatedBy Array<string>
value number

TumorMutationalBurdenStatusChoices

Type: string

TumorNeoantigenBurden

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value number

TumorNeoantigenBurdenCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
value number

TumorNeoantigenBurdenPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
updatedAt string(date-time)
updatedBy Array<string>
value number

UnspecifiedTumorBoard

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
recommendations Array<CodedConcept>
relatedEntitiesIds Array<string(uuid)>
updatedAt string(date-time)
updatedBy Array<string>

UnspecifiedTumorBoardCreate

Name Type
caseId string(uuid)
category string
date string(date)
externalSource string
externalSourceId string
recommendations Array<CodedConcept>
relatedEntitiesIds Array<string(uuid)>

UnspecifiedTumorBoardPartial

Name Type
anonymized boolean
caseId string(uuid)
category string
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
recommendations
relatedEntitiesIds Array<string(uuid)>
updatedAt string(date-time)
updatedBy Array<string>

User

Name Type
accessLevel integer
canExportData boolean
canManageCases boolean
canManageProjects boolean
canManageUsers boolean
canViewCases boolean
canViewCohorts boolean
canViewDatasets boolean
canViewProjects boolean
canViewUsers boolean
department string
email string
externalSource string
externalSourceId string
firstName string
fullName string
id string(uuid)
isActive boolean
isProvided boolean
isServiceAccount boolean
isSystemAdmin boolean
lastLogin string(date-time)
lastName string
organization string
provider string
role AccessRoles
shareable boolean
title string
username string

UserCreate

Name Type
accessLevel integer
department string
email string
externalSource string
externalSourceId string
firstName string
isActive boolean
isServiceAccount boolean
lastLogin string(date-time)
lastName string
organization string
shareable boolean
title string
username string

UserCredentials

Name Type
password string
username string

UserExport

Name Type
anonymized boolean
email string
externalSource string
externalSourceId string
firstName string
id string(uuid)
lastName string
organization string
username string

UserFilters

Name Type
accessLevel.between Array<>
accessLevel.equal integer
accessLevel.greaterThan integer
accessLevel.greaterThanOrEqual integer
accessLevel.lessThan integer
accessLevel.lessThanOrEqual integer
accessLevel.not.between Array<>
accessLevel.not.equal integer
canExportData boolean
canManageCases boolean
canManageProjects boolean
canManageUsers boolean
canViewCases boolean
canViewCohorts boolean
canViewDatasets boolean
canViewProjects boolean
canViewUsers boolean
department string
department.anyOf Array<string>
department.beginsWith string
department.contains string
department.endsWith string
department.exists boolean
department.not string
department.not.anyOf Array<string>
department.not.beginsWith string
department.not.contains string
department.not.endsWith string
department.not.exists boolean
email string
email.anyOf Array<string>
email.beginsWith string
email.contains string
email.endsWith string
email.exists boolean
email.not string
email.not.anyOf Array<string>
email.not.beginsWith string
email.not.contains string
email.not.endsWith string
email.not.exists boolean
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
firstName string
firstName.anyOf Array<string>
firstName.beginsWith string
firstName.contains string
firstName.endsWith string
firstName.exists boolean
firstName.not string
firstName.not.anyOf Array<string>
firstName.not.beginsWith string
firstName.not.contains string
firstName.not.endsWith string
firstName.not.exists boolean
fullName string
fullName.anyOf Array<string>
fullName.beginsWith string
fullName.contains string
fullName.endsWith string
fullName.not string
fullName.not.anyOf Array<string>
fullName.not.beginsWith string
fullName.not.contains string
fullName.not.endsWith string
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
isActive boolean
isProvided boolean
isServiceAccount boolean
isSystemAdmin boolean
lastLogin.after string(date)
lastLogin.before string(date)
lastLogin.between Array<>
lastLogin.exists boolean
lastLogin.not.between Array<>
lastLogin.not.exists boolean
lastLogin.not.on string(date)
lastLogin.on string(date)
lastLogin.onOrAfter string(date)
lastLogin.onOrBefore string(date)
lastName string
lastName.anyOf Array<string>
lastName.beginsWith string
lastName.contains string
lastName.endsWith string
lastName.exists boolean
lastName.not string
lastName.not.anyOf Array<string>
lastName.not.beginsWith string
lastName.not.contains string
lastName.not.endsWith string
lastName.not.exists boolean
organization string
organization.anyOf Array<string>
organization.beginsWith string
organization.contains string
organization.endsWith string
organization.exists boolean
organization.not string
organization.not.anyOf Array<string>
organization.not.beginsWith string
organization.not.contains string
organization.not.endsWith string
organization.not.exists boolean
provider string
provider.anyOf Array<string>
provider.beginsWith string
provider.contains string
provider.endsWith string
provider.exists boolean
provider.not string
provider.not.anyOf Array<string>
provider.not.beginsWith string
provider.not.contains string
provider.not.endsWith string
provider.not.exists boolean
role
role.anyOf Array<string>
role.not
shareable boolean
shareable.exists boolean
shareable.not.exists boolean
title string
title.anyOf Array<string>
title.beginsWith string
title.contains string
title.endsWith string
title.exists boolean
title.not string
title.not.anyOf Array<string>
title.not.beginsWith string
title.not.contains string
title.not.endsWith string
title.not.exists boolean
username string
username.anyOf Array<string>
username.beginsWith string
username.contains string
username.endsWith string
username.not string
username.not.anyOf Array<string>
username.not.beginsWith string
username.not.contains string
username.not.endsWith string

UserPasswordReset

Name Type
newPassword string
oldPassword string

UserProfile

Name Type
department string
email string
firstName string
lastName string
organization string
title string

UserProviderClientToken

Name Type
access_token string
client_id string
id_token string

UserProviderToken

Name Type
process
provider string
token UserProviderClientToken

Vitals

Name Type
anonymized boolean
bloodPressureDiastolic
bloodPressureSystolic
bodyMassIndex
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
height
id string(uuid)
temperature
updatedAt string(date-time)
updatedBy Array<string>
weight

VitalsCreate

Name Type
bloodPressureDiastolic
bloodPressureSystolic
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
height
temperature
weight

VitalsFilters

Name Type
bloodPressureDiastolic.between Array<>
bloodPressureDiastolic.equal number
bloodPressureDiastolic.exists boolean
bloodPressureDiastolic.greaterThan number
bloodPressureDiastolic.greaterThanOrEqual number
bloodPressureDiastolic.lessThan number
bloodPressureDiastolic.lessThanOrEqual number
bloodPressureDiastolic.not.between Array<>
bloodPressureDiastolic.not.equal number
bloodPressureDiastolic.not.exists boolean
bloodPressureSystolic.between Array<>
bloodPressureSystolic.equal number
bloodPressureSystolic.exists boolean
bloodPressureSystolic.greaterThan number
bloodPressureSystolic.greaterThanOrEqual number
bloodPressureSystolic.lessThan number
bloodPressureSystolic.lessThanOrEqual number
bloodPressureSystolic.not.between Array<>
bloodPressureSystolic.not.equal number
bloodPressureSystolic.not.exists boolean
bodyMassIndex.between Array<>
bodyMassIndex.equal number
bodyMassIndex.exists boolean
bodyMassIndex.greaterThan number
bodyMassIndex.greaterThanOrEqual number
bodyMassIndex.lessThan number
bodyMassIndex.lessThanOrEqual number
bodyMassIndex.not.between Array<>
bodyMassIndex.not.equal number
bodyMassIndex.not.exists boolean
caseId string
caseId.anyOf Array<string>
caseId.beginsWith string
caseId.contains string
caseId.endsWith string
caseId.not string
caseId.not.anyOf Array<string>
caseId.not.beginsWith string
caseId.not.contains string
caseId.not.endsWith string
createdAt.after string(date)
createdAt.before string(date)
createdAt.between Array<>
createdAt.exists boolean
createdAt.not.between Array<>
createdAt.not.exists boolean
createdAt.not.on string(date)
createdAt.on string(date)
createdAt.onOrAfter string(date)
createdAt.onOrBefore string(date)
date.after string(date)
date.before string(date)
date.between Array<>
date.not.between Array<>
date.not.on string(date)
date.on string(date)
date.onOrAfter string(date)
date.onOrBefore string(date)
externalSource string
externalSource.anyOf Array<string>
externalSource.beginsWith string
externalSource.contains string
externalSource.endsWith string
externalSource.exists boolean
externalSource.not string
externalSource.not.anyOf Array<string>
externalSource.not.beginsWith string
externalSource.not.contains string
externalSource.not.endsWith string
externalSource.not.exists boolean
height.between Array<>
height.equal number
height.exists boolean
height.greaterThan number
height.greaterThanOrEqual number
height.lessThan number
height.lessThanOrEqual number
height.not.between Array<>
height.not.equal number
height.not.exists boolean
id string
id.anyOf Array<string>
id.beginsWith string
id.contains string
id.endsWith string
id.not string
id.not.anyOf Array<string>
id.not.beginsWith string
id.not.contains string
id.not.endsWith string
temperature.between Array<>
temperature.equal number
temperature.exists boolean
temperature.greaterThan number
temperature.greaterThanOrEqual number
temperature.lessThan number
temperature.lessThanOrEqual number
temperature.not.between Array<>
temperature.not.equal number
temperature.not.exists boolean
updatedAt.after string(date)
updatedAt.before string(date)
updatedAt.between Array<>
updatedAt.exists boolean
updatedAt.not.between Array<>
updatedAt.not.exists boolean
updatedAt.not.on string(date)
updatedAt.on string(date)
updatedAt.onOrAfter string(date)
updatedAt.onOrBefore string(date)
weight.between Array<>
weight.equal number
weight.exists boolean
weight.greaterThan number
weight.greaterThanOrEqual number
weight.lessThan number
weight.lessThanOrEqual number
weight.not.between Array<>
weight.not.equal number
weight.not.exists boolean

VitalsPartial

Name Type
anonymized boolean
bloodPressureDiastolic
bloodPressureSystolic
bodyMassIndex
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
height
id string(uuid)
temperature
updatedAt string(date-time)
updatedBy Array<string>
weight

WilmsStage

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
description string
externalSource string
externalSourceId string
id string(uuid)
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

WilmsStageCreate

Name Type
caseId string(uuid)
date string(date)
externalSource string
externalSourceId string
stage CodedConcept
stagedEntitiesIds Array<string(uuid)>
stagingDomain string

WilmsStagePartial

Name Type
anonymized boolean
caseId string(uuid)
createdAt string(date-time)
createdBy string
date string(date)
externalSource string
externalSourceId string
id string(uuid)
stage
stagedEntitiesIds Array<string(uuid)>
stagingDomain string
updatedAt string(date-time)
updatedBy Array<string>

Security schemes

Name Type Scheme Description
XSessionTokenAuth apiKey
runner